✕
JSON Physical Model
Schema for:
Model name: IBPDI CDM V0.1.1-beta
Author:
Version:
File name: IBPDI_CDM_V0.1.1-beta.json
File path: /Users/joshuathiele/Desktop/IBPDI/CDM/CDM_V0.1.1-beta/IBPDI_CDM_V0.1.1-beta.json
Printed On: Thu Jun 10 2021 15:57:43 GMT+0200 (Central European Summer Time)
Created with: Hackolade - Visual data modeling for NoSQL and multimodel databases
1. Model
2. Groups
3. Relationships
- 3.1 New Relationship
- 3.2 New Relationship(1)
- 3.3 New Relationship(1)
- 3.4 New Relationship(10)
- 3.5 New Relationship(10)
- 3.6 New Relationship(11)
- 3.7 New Relationship(11)
- 3.8 New Relationship(12)
- 3.9 New Relationship(12)
- 3.10 New Relationship(13)
- 3.11 New Relationship(13)
- 3.12 New Relationship(14)
- 3.13 New Relationship(14)
- 3.14 New Relationship(15)
- 3.15 New Relationship(15)
- 3.16 New Relationship(16)
- 3.17 New Relationship(16)
- 3.18 New Relationship(18)
- 3.19 New Relationship(19)
- 3.20 New Relationship(2)
- 3.21 New Relationship(21)
- 3.22 New Relationship(22)
- 3.23 New Relationship(23)
- 3.24 New Relationship(24)
- 3.25 New Relationship(25)
- 3.26 New Relationship(26)
- 3.27 New Relationship(27)
- 3.28 New Relationship(28)
- 3.29 New Relationship(28)
- 3.30 New Relationship(29)
- 3.31 New Relationship(3)
- 3.32 New Relationship(30)
- 3.33 New Relationship(31)
- 3.34 New Relationship(32)
- 3.35 New Relationship(33)
- 3.36 New Relationship(34)
- 3.37 New Relationship(35)
- 3.38 New Relationship(36)
- 3.39 New Relationship(37)
- 3.40 New Relationship(4)
- 3.41 New Relationship(41)
- 3.42 New Relationship(42)
- 3.43 New Relationship(43)
- 3.44 New Relationship(43)
- 3.45 New Relationship(44)
- 3.46 New Relationship(45)
- 3.47 New Relationship(45)
- 3.48 New Relationship(45)
- 3.49 New Relationship(45)
- 3.50 New Relationship(45)
- 3.51 New Relationship(50)
- 3.52 New Relationship(51)
- 3.53 New Relationship(52)
- 3.54 New Relationship(54)
- 3.55 New Relationship(6)
- 3.56 New Relationship(6)
- 3.57 New Relationship(7)
- 3.58 New Relationship(7)
- 3.59 New Relationship(8)
- 3.60 New Relationship(8)
- 3.61 New Relationship(9)
- 3.62 New Relationship(9)
- 3.63 fk Account. to IndividualAccount.
- 3.64 fk Address. to AddressContact.
- 3.65 fk Address. to AddressOrganisation.
- 3.66 fk AreaMeasurement. to RentalUnitSpace copy.
- 3.67 fk Building. to AddressBuilding.
- 3.68 fk Building. to CertificateBuilding.
- 3.69 fk Building. to ClimateBuilding.
- 3.70 fk Building. to ComponentBuilding.
- 3.71 fk Building. to CostCenterBuilding.
- 3.72 fk Building. to EmissionFactorSite.
- 3.73 fk Building. to OperationalMeasurementBuilding.
- 3.74 fk Building. to OrganisationBuilding.
- 3.75 fk Building. to PortfolioBuilding.
- 3.76 fk Building. to RentalUnitBuilding.
- 3.77 fk Building. to SustainabilityIndicators.
- 3.78 fk Building. to TransactionBuilding.
- 3.79 fk Building. to ValuationBuilding.
- 3.80 fk Building. to gHgEmissionsBuilding.
- 3.81 fk Certificate. to CertificateBuilding.
- 3.82 fk Certificate. to CertificateBuilding.
- 3.83 fk Certificate. to CertificateBuilding.
- 3.84 fk Certificate. to CertificateBuilding.
- 3.85 fk Component. to Certificate.
- 3.86 fk Component. to Certificate.
- 3.87 fk Component. to New Document.
- 3.88 fk Component. to New Document.
- 3.89 fk Component. to New Document.
- 3.90 fk Component. to New Document.
- 3.91 fk Component. to New Document.
- 3.92 fk Component. to New Document.
- 3.93 fk Contact. to AddressContact.
- 3.94 fk Contact. to RoleContact.
- 3.95 fk CostCenter. to Transaction.
- 3.96 fk Floor. to ComponentFloor.
- 3.97 fk Floor. to OperationalMeasurementFloor.
- 3.98 fk Floor. to RentalUnitFloor.
- 3.99 fk IndividualAccount. to CostCenter.
- 3.100 fk IndividualAccount. to IndividualAccountPortfolio.
- 3.101 fk IndividualAccount. to Portfolio.
- 3.102 fk IndividualAccount. to TransactionBuilding.
- 3.103 fk IndividualAccount. to TransactionSite.
- 3.104 fk IndividualAccount. to ValuationAccount.
- 3.105 fk Land. to AddressLand.
- 3.106 fk Land. to OperationalMeasurementLand.
- 3.107 fk Land. to OrganisationLand.
- 3.108 fk Land. to PortfolioLand.
- 3.109 fk Land. to RentalUnitLand.
- 3.110 fk Land. to ValuationLand.
- 3.111 fk OperationalMeasurement. to ValuationOperationalMeasurement.
- 3.112 fk Organisation. to AccountOrganisation.
- 3.113 fk Organisation. to AddressOrganisation.
- 3.114 fk Organisation. to Contact.
- 3.115 fk Organisation. to CostCenter.
- 3.116 fk Organisation. to RoleOrganisation.
- 3.117 fk Portfolio. to CostCenterPortfolio.
- 3.118 fk Portfolio. to OrganisationPortfolio.
- 3.119 fk Portfolio. to PortfolioStrategy.
- 3.120 fk Portfolio. to PortfolioUnit.
- 3.121 fk Portfolio. to RolePortfolioStrategy.
- 3.122 fk Portfolio. to TransactionPortfolio.
- 3.123 fk RentalContract. to LeaseOption.
- 3.124 fk RentalContract. to RentalContractOrganisation.
- 3.125 fk RentalContract. to RentalPaymentId.
- 3.126 fk RentalPayment. to Dunning.
- 3.127 fk RentalUnit. to AddressRentalUnit.
- 3.128 fk RentalUnit. to CostCenterRentalUnit.
- 3.129 fk RentalUnit. to OrganisationRentalUnit.
- 3.130 fk RentalUnit. to TenantCommunication.
- 3.131 fk Role. to OperationalMeasurement.
- 3.132 fk Role. to OperationalMeasurement.
- 3.133 fk Role. to OrganisationBuilding.
- 3.134 fk Role. to OrganisationLand.
- 3.135 fk Role. to OrganisationPortfolioStrategy.
- 3.136 fk Role. to OrganisationRentalUnit.
- 3.137 fk Role. to OrganisationRentalUnit.
- 3.138 fk Role. to OrganisationSite.
- 3.139 fk Role. to OrganisationValuation.
- 3.140 fk Role. to RentalContractOrganisation.
- 3.141 fk Role. to RoleContact.
- 3.142 fk Role. to RoleContact.
- 3.143 fk Role. to TenantCommunicationRole.
- 3.144 fk Site. to AddressSite.
- 3.145 fk Site. to ClimateSite.
- 3.146 fk Site. to ComponentFloor(2).
- 3.147 fk Site. to CostCenterSite.
- 3.148 fk Site. to EmissionFactorBuilding.
- 3.149 fk Site. to OperationalMeasurementSite.
- 3.150 fk Site. to OrganisationSite.
- 3.151 fk Site. to PortfolioSite.
- 3.152 fk Site. to TransactionSite.
- 3.153 fk Site. to gHgEmissionsSite.
- 3.154 fk Space. to New Document.
- 3.155 fk Space. to OperationalMeasurementSpace.
- 3.156 fk Space. to RentalUnitSpace.
- 3.157 fk System. to CertificateSystem.
- 3.158 fk System. to ComponentSystem.
- 3.159 fk TenantCommunication. to TenantCommunication.
- 3.160 fk Type. to Component.
- 3.161 fk Unit. to ComponentUnit.
- 3.162 fk Unit. to OperationalMeasurementUnit.
- 3.163 fk Unit. to PortfolioUnit.
- 3.164 fk Unit. to RentalUnitUnit.
- 3.165 fk Valuation. to CertificateValuation.
- 3.166 fk Valuation. to OrganisationValuation.
- 3.167 fk Valuation. to ValuationAreaMeasurement.
- 3.168 fk Valuation. to ValuationAreaMeasurement.
- 3.169 fk Valuation. to ValuationAreaMeasurement.
- 3.170 fk Valuation. to ValuationAreaMeasurement.
1. Model
1.1 Model IBPDI CDM V0.1.1-beta
1.1.1 IBPDI CDM V0.1.1-beta Entity Relationship Diagram
1.1.2 IBPDI CDM V0.1.1-beta Properties
1.1.2.1 Details tab
| Property | Value |
| Model name | IBPDI CDM V0.1.1-beta |
| Technical name | |
| Description | |
| Author | |
| DB vendor | JSON |
| Version | |
| Comments | |
| Lineage |
1.1.3 IBPDI CDM V0.1.1-beta DB Definitions
2. Groups
2.1 Group DigitalTwin
2.1.1 DigitalTwin Properties
| Property | Value |
| Group name | DigitalTwin |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.1.2 DigitalTwin Documents
2.1.2.1 Document AreaMeasurement
2.1.2.1.1 AreaMeasurement Tree Diagram
2.1.2.1.2 AreaMeasurement Properties
| Property | Value |
| Document name | AreaMeasurement |
| Technical name | ArMsrmnt |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.1.3 AreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Standard | string | true | Area measurement standard | ||
| Type | string | true | Type of the standard area | ||
| Value | number | true | Value of measurement | [{"dataType":"float"}] | |
| Unit | string | true | Unit area is measured with | ||
| ValidFrom | date-time | true | Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.1.3.1 Field AreaMeasurementId
2.1.2.1.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
2.1.2.1.3.2 Field Standard
2.1.2.1.3.2.1 Standard properties
| Property | Value |
| Name | Standard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Area measurement standard |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | DIN 277-1,MFG,IPMS,RICS,BOMA,Not defined |
| Sample | Din 277-1 |
| Comments |
2.1.2.1.3.3 Field Type
2.1.2.1.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the standard area |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Gross floor area,Construction area,Net room area,Circulation area,Net usable area,Technical area,Living/residence area,Office area,Production / laboratory area,Storage/distribution/selling area,Education/teaching/culture area,Healing/care area,Other uses,Rentable exclusion,Rentable area,Rentable area common occupancy,Rentable area exclusive occupancy,Gross external area,External Wall area,Gross internal area,A-Vertical penetrations,B-Structural elements,C-Technical services,D-Hygiene areas,E-Circulation areas,F-Amenities,G-Workspace,H-Other areas,Boundary area,Rentable area common occupancy,Building amenity area,Building service area,Floor service area,Rentable area exclusive occupancy,Tenant ancillary area,Tenant area,Major vertical penetrations,Occupant Storage area,Parking area,Unenclosed Building Feature : Covered Gallery,Vacant area,Not defined |
| Sample | G-Workspace |
| Comments |
2.1.2.1.3.4 Field Value
2.1.2.1.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | Vl |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of measurement |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 230.45 |
| Comments | [{"dataType":"float"}] |
2.1.2.1.3.5 Field Unit
2.1.2.1.3.5.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | Unt |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit area is measured with |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | square meter,square feet |
| Sample | square meter |
| Comments |
2.1.2.1.3.6 Field ValidFrom
2.1.2.1.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | New Relationship(4) |
| Cardinality | 1 |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-25 12:09:21 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.1.3.7 Field ValidUntil
2.1.2.1.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-06-22 07:27:21 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.1.4 AreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurement",
"additionalProperties": false,
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Standard": {
"type": "string",
"description": "Area measurement standard",
"enum": [
"DIN 277-1",
"MFG",
"IPMS",
"RICS",
"BOMA",
"Not defined"
],
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of the standard area",
"enum": [
"Gross floor area",
"Construction area",
"Net room area",
"Circulation area",
"Net usable area",
"Technical area",
"Living/residence area",
"Office area",
"Production / laboratory area",
"Storage/distribution/selling area",
"Education/teaching/culture area",
"Healing/care area",
"Other uses",
"Rentable exclusion",
"Rentable area",
"Rentable area common occupancy",
"Rentable area exclusive occupancy",
"Gross external area",
"External Wall area",
"Gross internal area",
"A-Vertical penetrations",
"B-Structural elements",
"C-Technical services",
"D-Hygiene areas",
"E-Circulation areas",
"F-Amenities",
"G-Workspace",
"H-Other areas",
"Boundary area",
"Rentable area common occupancy",
"Building amenity area",
"Building service area",
"Floor service area",
"Rentable area exclusive occupancy",
"Tenant ancillary area",
"Tenant area",
"Major vertical penetrations",
"Occupant Storage area",
"Parking area",
"Unenclosed Building Feature : Covered Gallery",
"Vacant area",
"Not defined"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vl": {
"type": "number",
"description": "Value of measurement",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"Unt": {
"type": "string",
"description": "Unit area is measured with",
"enum": [
"square meter",
"square feet"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "Date measurement is not valid anymore /needs to be renewed in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"default": "2199-12-31 00:00:00"
}
},
"required": [
"AreaMeasurementId",
"Standard",
"Type",
"Vl",
"Unt",
"ValidFrom",
"ValidUntil"
]
}2.1.2.1.5 AreaMeasurement JSON data
{
"AreaMeasurementId": "AM-CH-SE-2312",
"Standard": "Din 277-1",
"Type": "G-Workspace",
"Vl": 230.45,
"Unt": "square meter",
"ValidFrom": "2021-03-25 12:09:21",
"ValidUntil": "2025-06-22 07:27:21"
}2.1.2.2 Document Building
2.1.2.2.1 Building Tree Diagram
2.1.2.2.2 Building Properties
| Property | Value |
| Document name | Building |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.2.3 Building Fields
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | User specific building name e.g: EMEA Headquarter, Office Berlin | ||
| BuildingCode | string | false | User specific Building Code | ||
| PrimaryTypeOfBuilding | string | true | Type of building use | ||
| SecondaryTypeOfBuilding | string | false | Second type of building use | ||
| EnergyEfficiencyClass | string | false | Energy Efficiency Class of Building | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ConstructionYear | date-time | false | Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| YearOfLastRefurbishment | date-time | false | Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| MonumentProtection | boolean | false | The building is declared to be an ancient monument with national importance by the government | ||
| TypeOfOwnership | string | true | Is the building owned or leased. | ||
| SelfUse | boolean | true | Is building self used or not (Y/N) | ||
| TenantStructure | string | true | Is there multiple tenants in the building or only one | ||
| ParkingSpaces | integer | false | Number of parking spaces | ||
| PrimaryEnergyType | string | false | Type of energy used | ||
| PrimaryWaterType | string | false | Type of water used | ||
| PrimaryHeatingType | string | false | Primary Type of heating | ||
| SecondaryHeatingType | string | false | Secondary Type of heating | ||
| AirConditioning | boolean | false | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) | ||
| SiteId | string | true | fk | Reference to the Site which the building belongs to |
2.1.2.2.3.1 Field BuildingId
2.1.2.2.3.1.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.2.3.2 Field Name
2.1.2.2.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific building name e.g: EMEA Headquarter, Office Berlin |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | HQ Berlin |
| Comments |
2.1.2.2.3.3 Field BuildingCode
2.1.2.2.3.3.1 BuildingCode properties
| Property | Value |
| Name | BuildingCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Building Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BC001 |
| Comments |
2.1.2.2.3.4 Field PrimaryTypeOfBuilding
2.1.2.2.3.4.1 PrimaryTypeOfBuilding properties
| Property | Value |
| Name | PrimaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of building use |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Lodging, Leisure & Recreation,Hotel,Education,Technology/Science,Health Care,Health Care, Health Care Center,Health Care, Senior Homes,Health Care, Other,Mixed Use,Other |
| Sample | Industrial, Manufacturing |
| Comments |
2.1.2.2.3.5 Field SecondaryTypeOfBuilding
2.1.2.2.3.5.1 SecondaryTypeOfBuilding properties
| Property | Value |
| Name | SecondaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Second type of building use |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Lodging, Leisure & Recreation,Hotel,Education,Technology/Science,Health Care,Health Care, Health Care Center,Health Care, Senior Homes,Health Care, Other,Mixed Use,Other |
| Sample | Industrial, Manufacturing |
| Comments |
2.1.2.2.3.6 Field EnergyEfficiencyClass
2.1.2.2.3.6.1 EnergyEfficiencyClass properties
| Property | Value |
| Name | EnergyEfficiencyClass |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Energy Efficiency Class of Building |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A++,A+,A,B,C,D,E,F,G,H |
| Sample | C |
| Comments |
2.1.2.2.3.7 Field ValidFrom
2.1.2.2.3.7.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | VldFrm |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-12 11:02:35 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.2.3.8 Field ValidUntil
2.1.2.2.3.8.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | Vldntl |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-01-25 12:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.2.3.9 Field ConstructionYear
2.1.2.2.3.9.1 ConstructionYear properties
| Property | Value |
| Name | ConstructionYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.2.3.10 Field YearOfLastRefurbishment
2.1.2.2.3.10.1 YearOfLastRefurbishment properties
| Property | Value |
| Name | YearOfLastRefurbishment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.2.3.11 Field MonumentProtection
2.1.2.2.3.11.1 MonumentProtection properties
| Property | Value |
| Name | MonumentProtection |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | The building is declared to be an ancient monument with national importance by the government |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.2.3.12 Field TypeOfOwnership
2.1.2.2.3.12.1 TypeOfOwnership properties
| Property | Value |
| Name | TypeOfOwnership |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is the building owned or leased. |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Owner,Tenant |
| Sample | Owner |
| Comments |
2.1.2.2.3.13 Field SelfUse
2.1.2.2.3.13.1 SelfUse properties
| Property | Value |
| Name | SelfUse |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is building self used or not (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.2.3.14 Field TenantStructure
2.1.2.2.3.14.1 TenantStructure properties
| Property | Value |
| Name | TenantStructure |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is there multiple tenants in the building or only one |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Single-tenant,Multi-tenant |
| Sample | Single-tenant |
| Comments |
2.1.2.2.3.15 Field ParkingSpaces
2.1.2.2.3.15.1 ParkingSpaces properties
| Property | Value |
| Name | ParkingSpaces |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Number of parking spaces |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 89 |
| Comments |
2.1.2.2.3.16 Field PrimaryEnergyType
2.1.2.2.3.16.1 PrimaryEnergyType properties
| Property | Value |
| Name | PrimaryEnergyType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of energy used |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Natural Gas,Coal,Nuclear,Petroleum,Hydropower,Wind,Biomass,Geothermal,Solar |
| Sample | |
| Comments |
2.1.2.2.3.17 Field PrimaryWaterType
2.1.2.2.3.17.1 PrimaryWaterType properties
| Property | Value |
| Name | PrimaryWaterType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of water used |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.2.2.3.18 Field PrimaryHeatingType
2.1.2.2.3.18.1 PrimaryHeatingType properties
| Property | Value |
| Name | PrimaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Primary Type of heating |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | District Heating,Natural Gas,Oil-based fuels,Solar Thermal |
| Sample | District Heating |
| Comments |
2.1.2.2.3.19 Field SecondaryHeatingType
2.1.2.2.3.19.1 SecondaryHeatingType properties
| Property | Value |
| Name | SecondaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Secondary Type of heating |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | District Heating,Natural Gas,Oil-based fuels,Solar Thermal |
| Sample | Solar Thermal |
| Comments |
2.1.2.2.3.20 Field AirConditioning
2.1.2.2.3.20.1 AirConditioning properties
| Property | Value |
| Name | AirConditioning |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.2.3.21 Field SiteId
2.1.2.2.3.21.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Site which the building belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.2.4 Building JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Building",
"additionalProperties": false,
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "User specific building name e.g: EMEA Headquarter, Office Berlin",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingCode": {
"type": "string",
"description": "User specific Building Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryTypeOfBuilding": {
"type": "string",
"description": "Type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Lodging, Leisure & Recreation",
"Hotel",
"Education",
"Technology/Science",
"Health Care",
"Health Care, Health Care Center",
"Health Care, Senior Homes",
"Health Care, Other",
"Mixed Use",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryTypeOfBuilding": {
"type": "string",
"description": "Second type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Lodging, Leisure & Recreation",
"Hotel",
"Education",
"Technology/Science",
"Health Care",
"Health Care, Health Care Center",
"Health Care, Senior Homes",
"Health Care, Other",
"Mixed Use",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiencyClass": {
"type": "string",
"description": "Energy Efficiency Class of Building",
"enum": [
"A++",
"A+",
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"VldFrm": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Vldntl": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ConstructionYear": {
"type": "string",
"description": "Year of construction in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"YearOfLastRefurbishment": {
"type": "string",
"description": "Year of last refurbishment took place in yyyy-mm-dd hh:mm:ss form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"MonumentProtection": {
"type": "boolean",
"description": "The building is declared to be an ancient monument with national importance by the government"
},
"TypeOfOwnership": {
"type": "string",
"description": "Is the building owned or leased.",
"enum": [
"Owner",
"Tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SelfUse": {
"type": "boolean",
"description": "Is building self used or not (Y/N)"
},
"TenantStructure": {
"type": "string",
"description": "Is there multiple tenants in the building or only one",
"enum": [
"Single-tenant",
"Multi-tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParkingSpaces": {
"type": "integer",
"description": "Number of parking spaces",
"maximum": 9999,
"minimum": 0
},
"PrimaryEnergyType": {
"type": "string",
"description": "Type of energy used",
"minLength": 1,
"maxLength": 50,
"enum": [
"Natural Gas",
"Coal",
"Nuclear",
"Petroleum",
"Hydropower",
"Wind",
"Biomass",
"Geothermal",
"Solar"
],
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWaterType": {
"type": "string",
"description": "Type of water used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryHeatingType": {
"type": "string",
"description": "Primary Type of heating",
"enum": [
"District Heating",
"Natural Gas",
"Oil-based fuels",
"Solar Thermal"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryHeatingType": {
"type": "string",
"description": "Secondary Type of heating",
"enum": [
"District Heating",
"Natural Gas",
"Oil-based fuels",
"Solar Thermal"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AirConditioning": {
"type": "boolean",
"description": "Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building)"
},
"Std": {
"type": "string",
"description": "Reference to the Site which the building belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"Name",
"PrimaryTypeOfBuilding",
"VldFrm",
"Vldntl",
"TypeOfOwnership",
"SelfUse",
"TenantStructure",
"Std"
]
}2.1.2.2.5 Building JSON data
{
"BuildingId": "SE-CH-2341",
"Name": "HQ Berlin",
"BuildingCode": "BC001",
"PrimaryTypeOfBuilding": "Industrial, Manufacturing",
"SecondaryTypeOfBuilding": "Industrial, Manufacturing",
"EnergyEfficiencyClass": "C",
"VldFrm": "2021-03-12 11:02:35",
"Vldntl": "2025-01-25 12:00:00",
"ConstructionYear": "2022-01-01 00:00:00",
"YearOfLastRefurbishment": "2021-01-01 00:00:00",
"MonumentProtection": true,
"TypeOfOwnership": "Owner",
"SelfUse": true,
"TenantStructure": "Single-tenant",
"ParkingSpaces": 89,
"PrimaryEnergyType": "Solar",
"PrimaryWaterType": "Lorem",
"PrimaryHeatingType": "District Heating",
"SecondaryHeatingType": "Solar Thermal",
"AirConditioning": true,
"Std": "AE-DE-02"
}2.1.2.3 Document BuildingAreaMeasurement
2.1.2.3.1 BuildingAreaMeasurement Tree Diagram
2.1.2.3.2 BuildingAreaMeasurement Properties
| Property | Value |
| Document name | BuildingAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.3.3 BuildingAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.3.3.1 Field BuildingId
2.1.2.3.3.1.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | New Relationship(6) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.3.3.2 Field AreaMeasurementId
2.1.2.3.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(6) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-23123 |
| Comments |
2.1.2.3.4 BuildingAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "BuildingAreaMeasurement",
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"AreaMeasurementId"
]
}2.1.2.3.5 BuildingAreaMeasurement JSON data
{
"BuildingId": "SE-CH-2341",
"AreaMeasurementId": "AM-CH-SE-23123"
}2.1.2.4 Document BuildingUnit
2.1.2.4.1 BuildingUnit Tree Diagram
2.1.2.4.2 BuildingUnit Properties
| Property | Value |
| Document name | BuildingUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.4.3 BuildingUnit Fields
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.4.3.1 Field BuildingId
2.1.2.4.3.1.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | New Relationship(14) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.4.3.2 Field UnitId
2.1.2.4.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(14) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341 |
| Comments |
2.1.2.4.4 BuildingUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "BuildingUnit",
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"UnitId"
]
}2.1.2.4.5 BuildingUnit JSON data
{
"BuildingId": "SE-CH-2341",
"UnitId": "UN-SE-CH-2341"
}2.1.2.5 Document Certificate
2.1.2.5.1 Certificate Tree Diagram
2.1.2.5.2 Certificate Properties
| Property | Value |
| Document name | Certificate |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.5.3 Certificate Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Name | string | true | Name of Certificate | ||
| Type | string | true | Type of Certificate e.g: LEED, BREEAM, DGNB | ||
| Value | string | true | Score, Grade if applicable for the certificate | ||
| IssuingDate | date-time | false | Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"DateTime"}] | |
| ValidFrom | date-time | true | Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ComponentId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.5.3.1 Field CertificateId
2.1.2.5.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.5.3.2 Field Name
2.1.2.5.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Certificate |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DGNB Platin |
| Comments |
2.1.2.5.3.3 Field Type
2.1.2.5.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Certificate e.g: LEED, BREEAM, DGNB |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LEED |
| Comments |
2.1.2.5.3.4 Field Value
2.1.2.5.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Score, Grade if applicable for the certificate |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Platin |
| Comments |
2.1.2.5.3.5 Field IssuingDate
2.1.2.5.3.5.1 IssuingDate properties
| Property | Value |
| Name | IssuingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"DateTime"}] |
2.1.2.5.3.6 Field ValidFrom
2.1.2.5.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-05-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.5.3.7 Field ValidUntil
2.1.2.5.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2024-05-24 12:03:12 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.5.3.8 Field ComponentId
2.1.2.5.3.8.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to Certificate. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.5.4 Certificate JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Certificate",
"additionalProperties": false,
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Certificate",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Certificate e.g: LEED, BREEAM, DGNB",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "string",
"description": "Score, Grade if applicable for the certificate",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"IssuingDate": {
"type": "string",
"description": "Date certificate was issued in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19
},
"ValidFrom": {
"type": "string",
"description": "Date certificate is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "Date certificate expires in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"Name",
"Type",
"Value",
"ValidFrom",
"ValidUntil"
]
}2.1.2.5.5 Certificate JSON data
{
"CertificateId": "CE-B8-2414",
"Name": "DGNB Platin",
"Type": "LEED",
"Value": "Platin",
"IssuingDate": "2021-03-21 00:00:00",
"ValidFrom": "2022-05-21 00:00:00",
"ValidUntil": "2024-05-24 12:03:12",
"ComponentId": "C-01"
}2.1.2.6 Document CertificateBuilding
2.1.2.6.1 CertificateBuilding Tree Diagram
2.1.2.6.2 CertificateBuilding Properties
| Property | Value |
| Document name | CertificateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.6.3 CertificateBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.6.3.1 Field CertificateId
2.1.2.6.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.6.3.2 Field BuildingId
2.1.2.6.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.6.4 CertificateBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateBuilding",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"BuildingId"
]
}2.1.2.6.5 CertificateBuilding JSON data
{
"CertificateId": "CE-B8-2414",
"BuildingId": "SE-CH-2341"
}2.1.2.7 Document CertificateComponent
2.1.2.7.1 CertificateComponent Tree Diagram
2.1.2.7.2 CertificateComponent Properties
| Property | Value |
| Document name | CertificateComponent |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.7.3 CertificateComponent Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.7.3.1 Field CertificateId
2.1.2.7.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.7.3.2 Field ComponentId
2.1.2.7.3.2.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to Certificate. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.7.4 CertificateComponent JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateComponent",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ComponentId"
]
}2.1.2.7.5 CertificateComponent JSON data
{
"CertificateId": "CE-B8-2414",
"ComponentId": "C-01"
}2.1.2.8 Document CertificateSystem
2.1.2.8.1 CertificateSystem Tree Diagram
2.1.2.8.2 CertificateSystem Properties
| Property | Value |
| Document name | CertificateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.8.3 CertificateSystem Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| SystemId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.8.3.1 Field CertificateId
2.1.2.8.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.8.3.2 Field SystemId
2.1.2.8.3.2.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | Foreign Key |
| Relationship name | fk System. to CertificateSystem. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
2.1.2.8.4 CertificateSystem JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateSystem",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"SystemId"
]
}2.1.2.8.5 CertificateSystem JSON data
{
"CertificateId": "CE-B8-2414",
"SystemId": "S-17281"
}2.1.2.9 Document CertificateValuation
2.1.2.9.1 CertificateValuation Tree Diagram
2.1.2.9.2 CertificateValuation Properties
| Property | Value |
| Document name | CertificateValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.9.3 CertificateValuation Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.1.2.9.3.1 Field CertificateId
2.1.2.9.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.9.3.2 Field ValuationId
2.1.2.9.3.2.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to CertificateValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.1.2.9.4 CertificateValuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateValuation",
"properties": {
"CertificateId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ValuationId"
]
}2.1.2.9.5 CertificateValuation JSON data
{
"CertificateId": "CE-B8-2414",
"ValuationId": "V021"
}2.1.2.10 Document Component
2.1.2.10.1 Component Tree Diagram
2.1.2.10.2 Component Properties
| Property | Value |
| Document name | Component |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.10.3 Component Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Counter | integer | false | Counter of component | ||
| ConditionStatus | string | true | Condition of component | ||
| DurationLifeYear | integer | true | Life span of component in years | [{"dataType":"integer16"}] | |
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SerialNumber | string | true | Serial number of component | ||
| TagNumber | string | false | Tag number | ||
| TypeId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.10.3.1 Field ComponentId
2.1.2.10.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.10.3.2 Field Counter
2.1.2.10.3.2.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of component |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
2.1.2.10.3.3 Field ConditionStatus
2.1.2.10.3.3.1 ConditionStatus properties
| Property | Value |
| Name | ConditionStatus |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Condition of component |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Defect,Good,Not Available |
| Sample | Good |
| Comments |
2.1.2.10.3.4 Field DurationLifeYear
2.1.2.10.3.4.1 DurationLifeYear properties
| Property | Value |
| Name | DurationLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Life span of component in years |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | years |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
2.1.2.10.3.5 Field WarrantyGuarantor
2.1.2.10.3.5.1 WarrantyGuarantor properties
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Apple |
| Comments |
2.1.2.10.3.6 Field WarrantyStartDate
2.1.2.10.3.6.1 WarrantyStartDate properties
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-28 11:21:21 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.10.3.7 Field SerialNumber
2.1.2.10.3.7.1 SerialNumber properties
| Property | Value |
| Name | SerialNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Serial number of component |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | xan51425612 |
| Comments |
2.1.2.10.3.8 Field TagNumber
2.1.2.10.3.8.1 TagNumber properties
| Property | Value |
| Name | TagNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Tag number |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 27465192 |
| Comments |
2.1.2.10.3.9 Field TypeId
2.1.2.10.3.9.1 TypeId properties
| Property | Value |
| Name | TypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Type |
| Foreign field | TypeId |
| Relationship type | Foreign Key |
| Relationship name | fk Type. to Component. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | T-2615 |
| Comments |
2.1.2.10.4 Component JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Component",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of component",
"minimum": 1,
"maximum": 99999
},
"ConditionStatus": {
"type": "string",
"description": "Condition of component",
"enum": [
"Defect",
"Good",
"Not Available"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DurationLifeYear": {
"type": "integer",
"description": "Life span of component in years",
"minimum": 1,
"maximum": 99
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"SerialNumber": {
"type": "string",
"description": "Serial number of component",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TagNumber": {
"type": "string",
"description": "Tag number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"ConditionStatus",
"DurationLifeYear",
"WarrantyGuarantor",
"WarrantyStartDate",
"SerialNumber",
"TypeId"
]
}2.1.2.10.5 Component JSON data
{
"ComponentId": "C-01",
"Counter": 21301,
"ConditionStatus": "Good",
"DurationLifeYear": 10,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2021-05-28 11:21:21",
"SerialNumber": "xan51425612",
"TagNumber": "27465192",
"TypeId": "T-2615"
}2.1.2.11 Document ComponentBuilding
2.1.2.11.1 ComponentBuilding Tree Diagram
2.1.2.11.2 ComponentBuilding Properties
| Property | Value |
| Document name | ComponentBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.11.3 ComponentBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.11.3.1 Field ComponentId
2.1.2.11.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.11.3.2 Field BuildingId
2.1.2.11.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ComponentBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.11.4 ComponentBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentBuilding",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"BuildingId"
]
}2.1.2.11.5 ComponentBuilding JSON data
{
"ComponentId": "C-01",
"BuildingId": "SE-CH-2341"
}2.1.2.12 Document ComponentFloor
2.1.2.12.1 ComponentFloor Tree Diagram
2.1.2.12.2 ComponentFloor Properties
| Property | Value |
| Document name | ComponentFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.12.3 ComponentFloor Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.12.3.1 Field ComponentId
2.1.2.12.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.12.3.2 Field FloorId
2.1.2.12.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to ComponentFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.12.4 ComponentFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentFloor",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"FloorId"
]
}2.1.2.12.5 ComponentFloor JSON data
{
"ComponentId": "C-01",
"FloorId": "SE-CH-F-01"
}2.1.2.13 Document ComponentSite
2.1.2.13.1 ComponentSite Tree Diagram
2.1.2.13.2 ComponentSite Properties
| Property | Value |
| Document name | ComponentSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.13.3 ComponentSite Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.13.3.1 Field ComponentId
2.1.2.13.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.13.3.2 Field SiteId
2.1.2.13.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to ComponentFloor(2). |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.13.4 ComponentSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSite",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SiteId"
]
}2.1.2.13.5 ComponentSite JSON data
{
"ComponentId": "C-01",
"SiteId": "AE-DE-02"
}2.1.2.14 Document ComponentSpace
2.1.2.14.1 ComponentSpace Tree Diagram
2.1.2.14.2 ComponentSpace Properties
| Property | Value |
| Document name | ComponentSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.14.3 ComponentSpace Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.14.3.1 Field ComponentId
2.1.2.14.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.14.3.2 Field SpaceId
2.1.2.14.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.14.4 ComponentSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSpace",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SpaceId"
]
}2.1.2.14.5 ComponentSpace JSON data
{
"ComponentId": "C-01",
"SpaceId": "SE-CH-F-01-21"
}2.1.2.15 Document ComponentSystem
2.1.2.15.1 ComponentSystem Tree Diagram
2.1.2.15.2 ComponentSystem Properties
| Property | Value |
| Document name | ComponentSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.15.3 ComponentSystem Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SystemId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.15.3.1 Field ComponentId
2.1.2.15.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.15.3.2 Field SystemId
2.1.2.15.3.2.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | |
| Relationship name | fk System. to ComponentSystem. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
2.1.2.15.4 ComponentSystem JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSystem",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SystemId"
]
}2.1.2.15.5 ComponentSystem JSON data
{
"ComponentId": "C-01",
"SystemId": "S-17281"
}2.1.2.16 Document ComponentUnit
2.1.2.16.1 ComponentUnit Tree Diagram
2.1.2.16.2 ComponentUnit Properties
| Property | Value |
| Document name | ComponentUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.16.3 ComponentUnit Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.16.3.1 Field ComponentId
2.1.2.16.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | |
| Relationship name | fk Component. to New Document. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C-01 |
| Comments |
2.1.2.16.3.2 Field UnitId
2.1.2.16.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to ComponentUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.16.4 ComponentUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentUnit",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"UnitId"
]
}2.1.2.16.5 ComponentUnit JSON data
{
"ComponentId": "C-01",
"UnitId": "UN-SE-CH-2341-02"
}2.1.2.17 Document Floor
2.1.2.17.1 Floor Tree Diagram
2.1.2.17.2 Floor Properties
| Property | Value |
| Document name | Floor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.17.3 Floor Fields
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | dk | Customer ID from previous system (ID before onboarding data to BM) | |
| Name | string | true | Name of floor | ||
| FloorCode | string | false | User specific Floor Code | ||
| FloorNumber | integer | true | Number of floor | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| BuildingId | string | true | fk | Reference to the Building which the Floor belongs to |
2.1.2.17.3.1 Field FloorId
2.1.2.17.3.1.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.17.3.2 Field Name
2.1.2.17.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of floor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | EG |
| Comments |
2.1.2.17.3.3 Field FloorCode
2.1.2.17.3.3.1 FloorCode properties
| Property | Value |
| Name | FloorCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Floor Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | F003 |
| Comments |
2.1.2.17.3.4 Field FloorNumber
2.1.2.17.3.4.1 FloorNumber properties
| Property | Value |
| Name | FloorNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Number of floor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -300 |
| Excl min | |
| Max value | 300 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 121 |
| Comments |
2.1.2.17.3.5 Field ValidFrom
2.1.2.17.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-01-03 11:56:34 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.17.3.6 Field ValidUntil
2.1.2.17.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2045-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.17.3.7 Field BuildingId
2.1.2.17.3.7.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | Bldngd |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Building which the Floor belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(2) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.17.4 Floor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Floor",
"additionalProperties": false,
"properties": {
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of floor",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorCode": {
"type": "string",
"description": "User specific Floor Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorNumber": {
"type": "integer",
"description": "Number of floor",
"minimum": -300,
"maximum": 300
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Bldngd": {
"type": "string",
"description": "Reference to the Building which the Floor belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"Name",
"FloorNumber",
"ValidFrom",
"ValidUntil",
"Bldngd"
]
}2.1.2.17.5 Floor JSON data
{
"FloorId": "SE-CH-F-01",
"Name": "EG",
"FloorCode": "F003",
"FloorNumber": 121,
"ValidFrom": "2023-01-03 11:56:34",
"ValidUntil": "2045-03-21 00:00:00",
"Bldngd": "SE-CH-2341"
}2.1.2.18 Document FloorAreaMeasurement
2.1.2.18.1 FloorAreaMeasurement Tree Diagram
2.1.2.18.2 FloorAreaMeasurement Properties
| Property | Value |
| Document name | FloorAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.18.3 FloorAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.18.3.1 Field FloorId
2.1.2.18.3.1.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | New Relationship(8) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.18.3.2 Field AreaMeasurementId
2.1.2.18.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(8) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-231231 |
| Comments |
2.1.2.18.4 FloorAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "FloorAreaMeasurement",
"properties": {
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"AreaMeasurementId"
]
}2.1.2.18.5 FloorAreaMeasurement JSON data
{
"FloorId": "SE-CH-F-01",
"AreaMeasurementId": "AM-CH-SE-231231"
}2.1.2.19 Document FloorUnit
2.1.2.19.1 FloorUnit Tree Diagram
2.1.2.19.2 FloorUnit Properties
| Property | Value |
| Document name | FloorUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.19.3 FloorUnit Fields
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.19.3.1 Field FloorId
2.1.2.19.3.1.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | New Relationship(15) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.19.3.2 Field UnitId
2.1.2.19.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(15) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-F-01 |
| Comments |
2.1.2.19.4 FloorUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "FloorUnit",
"properties": {
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"FloorId",
"UnitId"
]
}2.1.2.19.5 FloorUnit JSON data
{
"FloorId": "SE-CH-F-01",
"UnitId": "UN-SE-CH-F-01"
}2.1.2.20 Document Land
2.1.2.20.1 Land Tree Diagram
2.1.2.20.2 Land Properties
| Property | Value |
| Document name | Land |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.20.3 Land Fields
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) | ||
| Name | string | true | Name of Land e.g: park, garden, parking | ||
| LandCode | string | false | User specific Land Code | ||
| Type | string | true | Type of land | ||
| LandCover | string | true | Development level of land | ||
| LandParcelNr | string | false | District/Zoning number registered for the Plot of land | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SiteId | string | true | fk | Reference to the site which the land belongs to | |
| ServitudeId | string | false | fk | Reference to the Servitude which belongs to the land | |
| GeorefId | string | false | A reference to Guid from the geo-coordinate entity | does not exist yet |
2.1.2.20.3.1 Field LandId
2.1.2.20.3.1.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.1.2.20.3.2 Field Name
2.1.2.20.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Land e.g: park, garden, parking |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Parking Main Building |
| Comments |
2.1.2.20.3.3 Field LandCode
2.1.2.20.3.3.1 LandCode properties
| Property | Value |
| Name | LandCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Land Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LE3021 |
| Comments |
2.1.2.20.3.4 Field Type
2.1.2.20.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of land |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | agricultural,recreational,industrial,non-industrial,traffic |
| Sample | industrial |
| Comments |
2.1.2.20.3.5 Field LandCover
2.1.2.20.3.5.1 LandCover properties
| Property | Value |
| Name | LandCover |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Development level of land |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 30 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | full,partial,non |
| Sample | partial |
| Comments |
2.1.2.20.3.6 Field LandParcelNr
2.1.2.20.3.6.1 LandParcelNr properties
| Property | Value |
| Name | LandParcelNr |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | District/Zoning number registered for the Plot of land |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 00087/000 |
| Comments |
2.1.2.20.3.7 Field ValidFrom
2.1.2.20.3.7.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-21 16:27:12 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.20.3.8 Field ValidUntil
2.1.2.20.3.8.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2030-03-12 07:26:56 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.20.3.9 Field SiteId
2.1.2.20.3.9.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the site which the land belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(1) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.20.3.10 Field ServitudeId
2.1.2.20.3.10.1 ServitudeId properties
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Servitude which belongs to the land |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | Servitudes |
| Foreign field | ServitudeId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(1) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-DE-05 |
| Comments |
2.1.2.20.3.11 Field GeorefId
2.1.2.20.3.11.1 GeorefId properties
| Property | Value |
| Name | GeorefId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | A reference to Guid from the geo-coordinate entity |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | GR-02-01 |
| Comments | does not exist yet |
2.1.2.20.4 Land JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Land",
"additionalProperties": false,
"properties": {
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Land e.g: park, garden, parking",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCode": {
"type": "string",
"description": "User specific Land Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of land",
"enum": [
"agricultural",
"recreational",
"industrial",
"non-industrial",
"traffic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCover": {
"type": "string",
"description": "Development level of land",
"enum": [
"full",
"partial",
"non"
],
"minLength": 1,
"maxLength": 30,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandParcelNr": {
"type": "string",
"description": "District/Zoning number registered for the Plot of land",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"Std": {
"type": "string",
"description": "Reference to the site which the land belongs to",
"maxLength": 40,
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ServitudeId": {
"type": "string",
"description": "Reference to the Servitude which belongs to the land",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"GeorefId": {
"type": "string",
"description": "A reference to Guid from the geo-coordinate entity",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"Name",
"Type",
"LandCover",
"ValidFrom",
"ValidUntil",
"Std"
]
}2.1.2.20.5 Land JSON data
{
"LandId": "RE-AT-05",
"Name": "Parking Main Building",
"LandCode": "LE3021",
"Type": "industrial",
"LandCover": "partial",
"LandParcelNr": "00087/000",
"ValidFrom": "2021-04-21 16:27:12",
"ValidUntil": "2030-03-12 07:26:56",
"Std": "AE-DE-02",
"ServitudeId": "SE-DE-05",
"GeorefId": "GR-02-01"
}2.1.2.21 Document LandAreaMeasurement
2.1.2.21.1 LandAreaMeasurement Tree Diagram
2.1.2.21.2 LandAreaMeasurement Properties
| Property | Value |
| Document name | LandAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.21.3 LandAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.21.3.1 Field LandId
2.1.2.21.3.1.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | New Relationship(11) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.1.2.21.3.2 Field AreaMeasurementId
2.1.2.21.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(11) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-052 |
| Comments |
2.1.2.21.4 LandAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "LandAreaMeasurement",
"properties": {
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"AreaMeasurementId"
]
}2.1.2.21.5 LandAreaMeasurement JSON data
{
"LandId": "RE-AT-05",
"AreaMeasurementId": "RE-AT-052"
}2.1.2.22 Document LandUnit
2.1.2.22.1 LandUnit Tree Diagram
2.1.2.22.2 LandUnit Properties
| Property | Value |
| Document name | LandUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.22.3 LandUnit Fields
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.22.3.1 Field LandId
2.1.2.22.3.1.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | New Relationship(13) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.1.2.22.3.2 Field UnitId
2.1.2.22.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(13) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-RE-AT-05 |
| Comments |
2.1.2.22.4 LandUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "LandUnit",
"properties": {
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"UnitId"
]
}2.1.2.22.5 LandUnit JSON data
{
"LandId": "RE-AT-05",
"UnitId": "UN-RE-AT-05"
}2.1.2.23 Document Servitudes
2.1.2.23.1 Servitudes Tree Diagram
2.1.2.23.2 Servitudes Properties
| Property | Value |
| Document name | Servitudes |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.23.3 Servitudes Fields
| Field | Type | Req | Key | Description | Comments |
| ServitudeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of servitude | ||
| ValidFrom | date-time | true | Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.23.3.1 Field ServitudeId
2.1.2.23.3.1.1 ServitudeId properties
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-DE-05 |
| Comments |
2.1.2.23.3.2 Field Type
2.1.2.23.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of servitude |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Easements,Covenants,Profits |
| Sample | Easements |
| Comments |
2.1.2.23.3.3 Field ValidFrom
2.1.2.23.3.3.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2014-02-12 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.23.3.4 Field ValidUntil
2.1.2.23.3.4.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2034-02-12 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.23.4 Servitudes JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Servitudes",
"additionalProperties": false,
"properties": {
"ServitudeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of servitude ",
"enum": [
"Easements",
"Covenants",
"Profits"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date servitude starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date servitude ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
}
},
"required": [
"ServitudeId",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.1.2.23.5 Servitudes JSON data
{
"ServitudeId": "SE-DE-05",
"Type": "Easements",
"ValidFrom": "2014-02-12 00:00:00",
"ValidUntil": "2034-02-12 00:00:00"
}2.1.2.24 Document Site
2.1.2.24.1 Site Tree Diagram
2.1.2.24.2 Site Properties
| Property | Value |
| Document name | Site |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.24.3 Site Fields
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Site | ||
| SiteCode | string | false | User specific Site Code | ||
| Type | string | true | Type of site | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.24.3.1 Field SiteId
2.1.2.24.3.1.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.24.3.2 Field Name
2.1.2.24.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Site |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Siemensstadt |
| Comments |
2.1.2.24.3.3 Field SiteCode
2.1.2.24.3.3.1 SiteCode properties
| Property | Value |
| Name | SiteCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Site Code |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SB001 |
| Comments |
2.1.2.24.3.4 Field Type
2.1.2.24.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of site |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Education,Health Care,Hotel,Industrial,Lodging, Leisure & Recreation,Mixed use,Office,Residential,Retail,Technology/Science,Other |
| Sample | Office |
| Comments |
2.1.2.24.3.5 Field ValidFrom
2.1.2.24.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-21 12:31:13 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.24.3.6 Field ValidUntil
2.1.2.24.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-08-06 16:04:45 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.24.4 Site JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Site",
"additionalProperties": false,
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Site",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteCode": {
"type": "string",
"description": "User specific Site Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of site",
"enum": [
"Education",
"Health Care",
"Hotel",
"Industrial",
"Lodging, Leisure & Recreation",
"Mixed use",
"Office",
"Residential",
"Retail",
"Technology/Science",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
}
},
"required": [
"SiteId",
"Name",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.1.2.24.5 Site JSON data
{
"SiteId": "AE-DE-02",
"Name": "Siemensstadt",
"SiteCode": "SB001",
"Type": "Office",
"ValidFrom": "2021-04-21 12:31:13",
"ValidUntil": "2023-08-06 16:04:45"
}2.1.2.25 Document SiteAreaMeasurement
2.1.2.25.1 SiteAreaMeasurement Tree Diagram
2.1.2.25.2 SiteAreaMeasurement Properties
| Property | Value |
| Document name | SiteAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.25.3 SiteAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.25.3.1 Field SiteId
2.1.2.25.3.1.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | New Relationship(10) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.25.3.2 Field AreaMeasurementId
2.1.2.25.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(10) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
2.1.2.25.4 SiteAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SiteAreaMeasurement",
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SiteId",
"AreaMeasurementId"
]
}2.1.2.25.5 SiteAreaMeasurement JSON data
{
"SiteId": "AE-DE-02",
"AreaMeasurementId": "AM-CH-SE-2312"
}2.1.2.26 Document SiteUnit
2.1.2.26.1 SiteUnit Tree Diagram
2.1.2.26.2 SiteUnit Properties
| Property | Value |
| Document name | SiteUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.26.3 SiteUnit Fields
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.26.3.1 Field SiteId
2.1.2.26.3.1.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | New Relationship(7) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.26.3.2 Field UnitId
2.1.2.26.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(7) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.26.4 SiteUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SiteUnit",
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SiteId",
"UnitId"
]
}2.1.2.26.5 SiteUnit JSON data
{
"SiteId": "AE-DE-02",
"UnitId": "UN-SE-CH-2341-02"
}2.1.2.27 Document Space
2.1.2.27.1 Space Tree Diagram
2.1.2.27.2 Space Properties
| Property | Value |
| Document name | Space |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.27.3 Space Fields
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Name | string | true | Name of space | ||
| SpaceCode | string | false | User specific Space Code | ||
| SpaceNumber | number | false | Number of space | [{"dataType":"float"}] | |
| Type | string | true | Type of space | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SpaceHeightUsable | number | false | Usable Height of space | [{"dataType":"float"}] | |
| SpaceHeight | number | false | Actual space height e.g: 3.6 sqm | [{"dataType":"float"}] | |
| SpaceVolumeGross | number | false | Gross volume of space including surrounding walls | [{"dataType":"float"}] | |
| SpaceVolumeNet | number | false | Gross volume of space excluding surrounding walls | [{"dataType":"float"}] | |
| PrimaryFloorMaterial | string | false | Material of floor | ||
| PrimaryWallMaterial | string | false | Material of wall | ||
| PrimaryCeilingMaterial | string | false | Material of ceiling e.g: cement | ||
| Rentability | boolean | true | Status of the space is eligible for renting out (Y/N) | ||
| EffectZonesHeating | number | false | Area that is heated | [{"dataType":"float"}] | |
| EffectZonesCooling | number | false | Area that is cooled | [{"dataType":"float"}] | |
| EffectZonesVentilation | number | false | Area that is ventilated | [{"dataType":"float"}] | |
| ClimateHeated | boolean | false | Define if space is climate heated (Y/N) | ||
| ClimateCooled | boolean | false | Define if space is climate cooled (Y/N) | ||
| CoUseArea | boolean | true | Is the space used by multiple tenants (Y/N) | ||
| MaximumOccupancy | integer | false | Define maximum occupancy of space | ||
| VentilationType | string | false | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery | ||
| FloorId | string | true | fk | Reference to the floor which the space belongs to |
2.1.2.27.3.1 Field Name
2.1.2.27.3.1.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of space |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Meeting room 3c |
| Comments |
2.1.2.27.3.2 Field SpaceId
2.1.2.27.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.27.3.3 Field SpaceCode
2.1.2.27.3.3.1 SpaceCode properties
| Property | Value |
| Name | SpaceCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Space Code |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | MR003 |
| Comments |
2.1.2.27.3.4 Field SpaceNumber
2.1.2.27.3.4.1 SpaceNumber properties
| Property | Value |
| Name | SpaceNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Number of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | true |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 3.2 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.5 Field Type
2.1.2.27.3.5.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of space |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Residential,Office,Industrial,Retail,Storage,Parking space,Shaft,Staircase,Other |
| Sample | Office |
| Comments |
2.1.2.27.3.6 Field ValidFrom
2.1.2.27.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2014-03-02 12:21:13 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.27.3.7 Field ValidUntil
2.1.2.27.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2024-03-01 12:21:23 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.27.3.8 Field SpaceHeightUsable
2.1.2.27.3.8.1 SpaceHeightUsable properties
| Property | Value |
| Name | SpaceHeightUsable |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Usable Height of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | meter (m) |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.3 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.9 Field SpaceHeight
2.1.2.27.3.9.1 SpaceHeight properties
| Property | Value |
| Name | SpaceHeight |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Actual space height e.g: 3.6 sqm |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | meter (m) |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.11 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.10 Field SpaceVolumeGross
2.1.2.27.3.10.1 SpaceVolumeGross properties
| Property | Value |
| Name | SpaceVolumeGross |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Gross volume of space including surrounding walls |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Cubic meter (m³) |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1083.27 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.11 Field SpaceVolumeNet
2.1.2.27.3.11.1 SpaceVolumeNet properties
| Property | Value |
| Name | SpaceVolumeNet |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Gross volume of space excluding surrounding walls |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Cubic meter (m³) |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1200.21 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.12 Field PrimaryFloorMaterial
2.1.2.27.3.12.1 PrimaryFloorMaterial properties
| Property | Value |
| Name | PrimaryFloorMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of floor |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Laminate,Vinyl,Bamboo,Cork,Tile (porcelain or ceramic),Tile (natural stone),Carpet,Rubber,Poured floors (mastic asphalt and polymeric) |
| Sample | Timber |
| Comments |
2.1.2.27.3.13 Field PrimaryWallMaterial
2.1.2.27.3.13.1 PrimaryWallMaterial properties
| Property | Value |
| Name | PrimaryWallMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of wall |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Paint,Tiles,Glass,Brick,Metal,Vinyl,Stone,Concrete,Ceramic Tiles,Plastic |
| Sample | Concrete |
| Comments |
2.1.2.27.3.14 Field PrimaryCeilingMaterial
2.1.2.27.3.14.1 PrimaryCeilingMaterial properties
| Property | Value |
| Name | PrimaryCeilingMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of ceiling e.g: cement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Timber,Glypsum,Vinyl,Fibre-cement |
| Sample | Timber |
| Comments |
2.1.2.27.3.15 Field Rentability
2.1.2.27.3.15.1 Rentability properties
| Property | Value |
| Name | Rentability |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Status of the space is eligible for renting out (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.27.3.16 Field EffectZonesHeating
2.1.2.27.3.16.1 EffectZonesHeating properties
| Property | Value |
| Name | EffectZonesHeating |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is heated |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1231.16 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.17 Field EffectZonesCooling
2.1.2.27.3.17.1 EffectZonesCooling properties
| Property | Value |
| Name | EffectZonesCooling |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is cooled |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 40.55 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.18 Field EffectZonesVentilation
2.1.2.27.3.18.1 EffectZonesVentilation properties
| Property | Value |
| Name | EffectZonesVentilation |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Area that is ventilated |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Square meter (m²) |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 122.98 |
| Comments | [{"dataType":"float"}] |
2.1.2.27.3.19 Field ClimateHeated
2.1.2.27.3.19.1 ClimateHeated properties
| Property | Value |
| Name | ClimateHeated |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Define if space is climate heated (Y/N) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.27.3.20 Field ClimateCooled
2.1.2.27.3.20.1 ClimateCooled properties
| Property | Value |
| Name | ClimateCooled |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Define if space is climate cooled (Y/N) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.27.3.21 Field CoUseArea
2.1.2.27.3.21.1 CoUseArea properties
| Property | Value |
| Name | CoUseArea |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the space used by multiple tenants (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.1.2.27.3.22 Field MaximumOccupancy
2.1.2.27.3.22.1 MaximumOccupancy properties
| Property | Value |
| Name | MaximumOccupancy |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Define maximum occupancy of space |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments |
2.1.2.27.3.23 Field VentilationType
2.1.2.27.3.23.1 VentilationType properties
| Property | Value |
| Name | VentilationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | Exhaust,Supply,Balanced,Heat-recovery |
| Sample | Exhaust |
| Comments |
2.1.2.27.3.24 Field FloorId
2.1.2.27.3.24.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the floor which the space belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(3) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.27.4 Space JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Space",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of space",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceCode": {
"type": "string",
"description": "User specific Space Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceNumber": {
"type": "number",
"description": "Number of space",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 99999
},
"Type": {
"type": "string",
"description": "Type of space",
"enum": [
"Residential",
"Office",
"Industrial",
"Retail",
"Storage",
"Parking space",
"Shaft",
"Staircase",
"Other"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"SpaceHeightUsable": {
"type": "number",
"description": "Usable Height of space",
"minimum": 2,
"maximum": 999
},
"SpaceHeight": {
"type": "number",
"description": "Actual space height e.g: 3.6 sqm",
"minimum": 2,
"maximum": 999
},
"SpaceVolumeGross": {
"type": "number",
"description": "Gross volume of space including surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"SpaceVolumeNet": {
"type": "number",
"description": "Gross volume of space excluding surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"PrimaryFloorMaterial": {
"type": "string",
"description": "Material of floor",
"enum": [
"Timber",
"Laminate",
"Vinyl",
"Bamboo",
"Cork",
"Tile (porcelain or ceramic)",
"Tile (natural stone)",
"Carpet",
"Rubber",
"Poured floors (mastic asphalt and polymeric)"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWallMaterial": {
"type": "string",
"description": "Material of wall",
"enum": [
"Timber",
"Paint",
"Tiles",
"Glass",
"Brick",
"Metal",
"Vinyl",
"Stone",
"Concrete",
"Ceramic Tiles",
"Plastic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryCeilingMaterial": {
"type": "string",
"description": "Material of ceiling e.g: cement",
"enum": [
"Timber",
"Glypsum",
"Vinyl",
"Fibre-cement"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"Rentability": {
"type": "boolean",
"description": "Status of the space is eligible for renting out (Y/N)"
},
"EffectZonesHeating": {
"type": "number",
"description": "Area that is heated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesCooling": {
"type": "number",
"description": "Area that is cooled",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesVentilation": {
"type": "number",
"description": "Area that is ventilated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"ClimateHeated": {
"type": "boolean",
"description": "Define if space is climate heated (Y/N)"
},
"ClimateCooled": {
"type": "boolean",
"description": "Define if space is climate cooled (Y/N)"
},
"CoUseArea": {
"type": "boolean",
"description": "Is the space used by multiple tenants (Y/N)"
},
"MaximumOccupancy": {
"type": "integer",
"description": "Define maximum occupancy of space",
"minimum": 1,
"maximum": 99999
},
"VentilationType": {
"type": "string",
"description": "Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery",
"enum": [
"Exhaust",
"Supply",
"Balanced",
"Heat-recovery"
]
},
"FloorId": {
"type": "string",
"description": "Reference to the floor which the space belongs to",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"Name",
"SpaceId",
"Type",
"ValidFrom",
"ValidUntil",
"Rentability",
"CoUseArea",
"FloorId"
]
}2.1.2.27.5 Space JSON data
{
"Name": "Meeting room 3c",
"SpaceId": "SE-CH-F-01-21",
"SpaceCode": "MR003",
"SpaceNumber": 3.2,
"Type": "Office",
"ValidFrom": "2014-03-02 12:21:13",
"ValidUntil": "2024-03-01 12:21:23",
"SpaceHeightUsable": 2.3,
"SpaceHeight": 2.11,
"SpaceVolumeGross": 1083.27,
"SpaceVolumeNet": 1200.21,
"PrimaryFloorMaterial": "Timber",
"PrimaryWallMaterial": "Concrete",
"PrimaryCeilingMaterial": "Timber",
"Rentability": true,
"EffectZonesHeating": 1231.16,
"EffectZonesCooling": 40.55,
"EffectZonesVentilation": 122.98,
"ClimateHeated": true,
"ClimateCooled": true,
"CoUseArea": true,
"MaximumOccupancy": 10,
"VentilationType": "Exhaust",
"FloorId": "SE-CH-F-01"
}2.1.2.28 Document SpaceAreaMeasurement
2.1.2.28.1 SpaceAreaMeasurement Tree Diagram
2.1.2.28.2 SpaceAreaMeasurement Properties
| Property | Value |
| Document name | SpaceAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.28.3 SpaceAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.28.3.1 Field SpaceId
2.1.2.28.3.1.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | New Relationship(9) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.28.3.2 Field AreaMeasurementId
2.1.2.28.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(9) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312312 |
| Comments |
2.1.2.28.4 SpaceAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SpaceAreaMeasurement",
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SpaceId",
"AreaMeasurementId"
]
}2.1.2.28.5 SpaceAreaMeasurement JSON data
{
"SpaceId": "SE-CH-F-01-21",
"AreaMeasurementId": "AM-CH-SE-2312312"
}2.1.2.29 Document SpaceUnit
2.1.2.29.1 SpaceUnit Tree Diagram
2.1.2.29.2 SpaceUnit Properties
| Property | Value |
| Document name | SpaceUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.29.3 SpaceUnit Fields
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.29.3.1 Field SpaceId
2.1.2.29.3.1.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | New Relationship(16) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.29.3.2 Field UnitId
2.1.2.29.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(16) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.29.4 SpaceUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SpaceUnit",
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SpaceId",
"UnitId"
]
}2.1.2.29.5 SpaceUnit JSON data
{
"SpaceId": "SE-CH-F-01-21",
"UnitId": "UN-SE-CH-2341-02"
}2.1.2.30 Document System
2.1.2.30.1 System Tree Diagram
2.1.2.30.2 System Properties
| Property | Value |
| Document name | System |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.30.3 System Fields
| Field | Type | Req | Key | Description | Comments |
| SystemId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of system | ||
| Class | string | true | Class system belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of system | ||
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-dd form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.30.3.1 Field SystemId
2.1.2.30.3.1.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | S-17281 |
| Comments |
2.1.2.30.3.2 Field Name
2.1.2.30.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of system |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Assembly system |
| Comments |
2.1.2.30.3.3 Field Class
2.1.2.30.3.3.1 Class properties
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class system belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | A |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
2.1.2.30.3.4 Field Counter
2.1.2.30.3.4.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of system |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 12 |
| Comments |
2.1.2.30.3.5 Field WarrantyGuarantor
2.1.2.30.3.5.1 WarrantyGuarantor properties
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Apple |
| Comments |
2.1.2.30.3.6 Field WarrantyStartDate
2.1.2.30.3.6.1 WarrantyStartDate properties
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-dd form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-28 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.30.4 System JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "System",
"properties": {
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of system",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class system belongs to"
},
"Counter": {
"type": "integer",
"description": "Counter of system",
"minimum": 0,
"maximum": 999999
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-dd form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
}
},
"required": [
"SystemId",
"Name",
"Class",
"Counter",
"WarrantyGuarantor",
"WarrantyStartDate"
]
}2.1.2.30.5 System JSON data
{
"SystemId": "S-17281",
"Name": "Assembly system",
"Class": "A",
"Counter": 12,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2021-05-28 00:00:00"
}2.1.2.31 Document Type
2.1.2.31.1 Type Tree Diagram
2.1.2.31.2 Type Properties
| Property | Value |
| Document name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.31.3 Type Fields
| Field | Type | Req | Key | Description | Comments |
| TypeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of product | ||
| Class | string | true | Class component belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of type | ||
| Manufacturer | string | true | Name of manufacturer | ||
| ManufacturerCode | string | false | Manufacturer code | ||
| ExpectedLifeYear | integer | false | Life span of product in years | [{"dataType":"integer16"}] | |
| MaintenanceGroup | string | false | Maintenance group | ||
| MaintenanceRelevance | string | false | Relevance of maintenance | ||
| URLLibrary | string | false | Product website | ||
| CE-Identification | string | false | European identification number |
2.1.2.31.3.1 Field TypeId
2.1.2.31.3.1.1 TypeId properties
| Property | Value |
| Name | TypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | T-2615 |
| Comments |
2.1.2.31.3.2 Field Name
2.1.2.31.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of product |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Door |
| Comments |
2.1.2.31.3.3 Field Class
2.1.2.31.3.3.1 Class properties
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class component belongs to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Door |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
2.1.2.31.3.4 Field Counter
2.1.2.31.3.4.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Counter of type |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 12 |
| Comments |
2.1.2.31.3.5 Field Manufacturer
2.1.2.31.3.5.1 Manufacturer properties
| Property | Value |
| Name | Manufacturer |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of manufacturer |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bosch |
| Comments |
2.1.2.31.3.6 Field ManufacturerCode
2.1.2.31.3.6.1 ManufacturerCode properties
| Property | Value |
| Name | ManufacturerCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Manufacturer code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B6274519 |
| Comments |
2.1.2.31.3.7 Field ExpectedLifeYear
2.1.2.31.3.7.1 ExpectedLifeYear properties
| Property | Value |
| Name | ExpectedLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Life span of product in years |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | years |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
2.1.2.31.3.8 Field MaintenanceGroup
2.1.2.31.3.8.1 MaintenanceGroup properties
| Property | Value |
| Name | MaintenanceGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Maintenance group |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.2.31.3.9 Field MaintenanceRelevance
2.1.2.31.3.9.1 MaintenanceRelevance properties
| Property | Value |
| Name | MaintenanceRelevance |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Relevance of maintenance |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | High,Medium,Low |
| Sample | High |
| Comments |
2.1.2.31.3.10 Field URLLibrary
2.1.2.31.3.10.1 URLLibrary properties
| Property | Value |
| Name | URLLibrary |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Product website |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke |
| Comments |
2.1.2.31.3.11 Field CE-Identification
2.1.2.31.3.11.1 CE-Identification properties
| Property | Value |
| Name | CE-Identification |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | European identification number |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | CE 0123 |
| Comments |
2.1.2.31.4 Type JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Type",
"properties": {
"TypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of product",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class component belongs to",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of type",
"minimum": 0,
"maximum": 999999
},
"Manufacturer": {
"type": "string",
"description": "Name of manufacturer",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ManufacturerCode": {
"type": "string",
"description": "Manufacturer code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ExpectedLifeYear": {
"type": "integer",
"description": "Life span of product in years",
"minimum": 1,
"maximum": 99
},
"MaintenanceGroup": {
"type": "string",
"description": "Maintenance group",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"MaintenanceRelevance": {
"type": "string",
"description": "Relevance of maintenance",
"enum": [
"High",
"Medium",
"Low"
],
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"URLLibrary": {
"type": "string",
"description": "Product website",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CE-Identification": {
"type": "string",
"description": "European identification number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TypeId",
"Name",
"Class",
"Counter",
"Manufacturer"
]
}2.1.2.31.5 Type JSON data
{
"TypeId": "T-2615",
"Name": "Door",
"Class": "Door",
"Counter": 12,
"Manufacturer": "Bosch",
"ManufacturerCode": "B6274519",
"ExpectedLifeYear": 10,
"MaintenanceGroup": "Lorem",
"MaintenanceRelevance": "High",
"URLLibrary": "www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke",
"CE-Identification": "CE 0123"
}2.1.2.32 Document Unit
2.1.2.32.1 Unit Tree Diagram
2.1.2.32.2 Unit Properties
| Property | Value |
| Document name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | false |
| Comments |
2.1.2.32.3 Unit Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of Unit e.g: part of building, rental unit | ||
| Name | string | true | Name of unit | ||
| Code | string | false | User-specific code for unit | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.32.3.1 Field UnitId
2.1.2.32.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.32.3.2 Field Type
2.1.2.32.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Unit e.g: part of building, rental unit |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | East Wing |
| Comments |
2.1.2.32.3.3 Field Name
2.1.2.32.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of unit |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | East Wing |
| Comments |
2.1.2.32.3.4 Field Code
2.1.2.32.3.4.1 Code properties
| Property | Value |
| Name | Code |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User-specific code for unit |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C602 |
| Comments |
2.1.2.32.3.5 Field ValidFrom
2.1.2.32.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-05-07 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.32.3.6 Field ValidUntil
2.1.2.32.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2027-09-19 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.32.4 Unit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Unit",
"additionalProperties": false,
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Unit e.g: part of building, rental unit",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Code": {
"type": "string",
"description": "User-specific code for unit",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"default": "2199-12-31 00:00:00"
}
},
"required": [
"UnitId",
"Type",
"Name",
"ValidFrom",
"ValidUntil"
]
}2.1.2.32.5 Unit JSON data
{
"UnitId": "UN-SE-CH-2341-02",
"Type": "East Wing",
"Name": "East Wing",
"Code": "C602",
"ValidFrom": "2022-05-07 00:00:00",
"ValidUntil": "2027-09-19 00:00:00"
}2.1.2.33 Document UnitAreaMeasurement
2.1.2.33.1 UnitAreaMeasurement Tree Diagram
2.1.2.33.2 UnitAreaMeasurement Properties
| Property | Value |
| Document name | UnitAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | DigitalTwin |
| Additional properties | |
| Comments |
2.1.2.33.3 UnitAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.1.2.33.3.1 Field UnitId
2.1.2.33.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | New Relationship(12) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.33.3.2 Field AreaMeasurementId
2.1.2.33.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | New Relationship(12) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Am-UN-SE-CH-2341-02 |
| Comments |
2.1.2.33.4 UnitAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitAreaMeasurement",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"AreaMeasurementId"
]
}2.1.2.33.5 UnitAreaMeasurement JSON data
{
"UnitId": "UN-SE-CH-2341-02",
"AreaMeasurementId": "Am-UN-SE-CH-2341-02"
}2.2 Group EnergyAndResources
2.2.1 EnergyAndResources Properties
| Property | Value |
| Group name | EnergyAndResources |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.2.2 EnergyAndResources Documents
2.2.2.1 Document Climate
2.2.2.1.1 Climate Tree Diagram
2.2.2.1.2 Climate Properties
| Property | Value |
| Document name | Climate |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.1.3 Climate Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Globally Unique Identifier number | ||
| Experiment | string | false | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 | ||
| TemporalResolution | string | false | Temporal resolution of data (can be the time period over which raw data is aggregated) | ||
| SpatialResolution | string | false | Spatial resolution of data | ||
| GCM | string | false | Global climate model used | ||
| RCM | string | false | Regional climate model used | ||
| SimV | string | false | Run number of certain climate model or model combination | ||
| EnsM | string | false | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' | ||
| Value | number | true | Value of observed variable | [{"dataType":"float"}] | |
| Unit | string | true | Unit of observed value | ||
| ValidFrom | date-time | true | Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| LocationType | string | true | Type of spatial reference e.g. Zip code or geographic coordinates | ||
| CoordinateSystem | string | false | Specific coordinate system used | ||
| Location | string | false | Localisation of observed data in case of non-grid location types | ||
| Lat | integer | false | Latitude coordinate in case of geographic coordinates | ||
| Lon | integer | false | Longitude coordinate in case of geographic coordinates | ||
| PosX | integer | false | |||
| PosY | integer | false | Vertical coordinate in case of projected coordinates | ||
| Variable | string | true | Observed variable |
2.2.2.1.3.1 Field Experiment
2.2.2.1.3.1.1 Experiment properties
| Property | Value |
| Name | Experiment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Historical |
| Comments |
2.2.2.1.3.2 Field TemporalResolution
2.2.2.1.3.2.1 TemporalResolution properties
| Property | Value |
| Name | TemporalResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Temporal resolution of data (can be the time period over which raw data is aggregated) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | monthly |
| Comments |
2.2.2.1.3.3 Field SpatialResolution
2.2.2.1.3.3.1 SpatialResolution properties
| Property | Value |
| Name | SpatialResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Spatial resolution of data |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 0.11 degree x 0.11 degree |
| Comments |
2.2.2.1.3.4 Field GCM
2.2.2.1.3.4.1 GCM properties
| Property | Value |
| Name | GCM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Global climate model used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | MPI-M-MPI-ESM-LR |
| Comments |
2.2.2.1.3.5 Field RCM
2.2.2.1.3.5.1 RCM properties
| Property | Value |
| Name | RCM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Regional climate model used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AWI-HIRHAM5 |
| Comments |
2.2.2.1.3.6 Field SimV
2.2.2.1.3.6.1 SimV properties
| Property | Value |
| Name | SimV |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Run number of certain climate model or model combination |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.7 Field EnsM
2.2.2.1.3.7.1 EnsM properties
| Property | Value |
| Name | EnsM |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | r1i1p1 |
| Comments |
2.2.2.1.3.8 Field Value
2.2.2.1.3.8.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of observed variable |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 28462827.85 |
| Comments | [{"dataType":"float"}] |
2.2.2.1.3.9 Field Unit
2.2.2.1.3.9.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of observed value |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Celsius |
| Comments |
2.2.2.1.3.10 Field ValidFrom
2.2.2.1.3.10.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-08-16 12:02:13 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.1.3.11 Field ValidUntil
2.2.2.1.3.11.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-08-19 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.1.3.12 Field LocationType
2.2.2.1.3.12.1 LocationType properties
| Property | Value |
| Name | LocationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of spatial reference e.g. Zip code or geographic coordinates |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | NUTS3,Zip Code,Geographic coordinates,Projected coordinates |
| Sample | Geographic coordinates |
| Comments |
2.2.2.1.3.13 Field CoordinateSystem
2.2.2.1.3.13.1 CoordinateSystem properties
| Property | Value |
| Name | CoordinateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific coordinate system used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.14 Field Location
2.2.2.1.3.14.1 Location properties
| Property | Value |
| Name | Location |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Localisation of observed data in case of non-grid location types |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE27C |
| Comments |
2.2.2.1.3.15 Field Lat
2.2.2.1.3.15.1 Lat properties
| Property | Value |
| Name | Lat |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Latitude coordinate in case of geographic coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.16 Field Lon
2.2.2.1.3.16.1 Lon properties
| Property | Value |
| Name | Lon |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Longitude coordinate in case of geographic coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.17 Field PosX
2.2.2.1.3.17.1 PosX properties
| Property | Value |
| Name | PosX |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.18 Field PosY
2.2.2.1.3.18.1 PosY properties
| Property | Value |
| Name | PosY |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Description | Vertical coordinate in case of projected coordinates |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | |
| Comments |
2.2.2.1.3.19 Field Variable
2.2.2.1.3.19.1 Variable properties
| Property | Value |
| Name | Variable |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Observed variable |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | HDD |
| Comments |
2.2.2.1.3.20 Field ClimateGuid
2.2.2.1.3.20.1 ClimateGuid properties
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 075a2983-a8e5-4ea8-a354-6a88b311bfdb |
| Comments |
2.2.2.1.4 Climate JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Climate",
"properties": {
"Experiment": {
"type": "string",
"description": "Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TemporalResolution": {
"type": "string",
"description": "Temporal resolution of data (can be the time period over which raw data is aggregated)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpatialResolution": {
"type": "string",
"description": "Spatial resolution of data",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"GCM": {
"type": "string",
"description": "Global climate model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RCM": {
"type": "string",
"description": "Regional climate model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SimV": {
"type": "string",
"description": "Run number of certain climate model or model combination",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnsM": {
"type": "string",
"description": "Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of observed variable",
"minimum": 1,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of observed value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date observation starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date observation ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"LocationType": {
"type": "string",
"description": "Type of spatial reference e.g. Zip code or geographic coordinates",
"minLength": 1,
"enum": [
"NUTS3",
"Zip Code",
"Geographic coordinates",
"Projected coordinates"
],
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CoordinateSystem": {
"type": "string",
"description": "Specific coordinate system used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Location": {
"type": "string",
"description": "Localisation of observed data in case of non-grid location types",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Lat": {
"type": "integer",
"description": "Latitude coordinate in case of geographic coordinates"
},
"Lon": {
"type": "integer",
"description": "Longitude coordinate in case of geographic coordinates"
},
"PosX": {
"type": "integer"
},
"PosY": {
"type": "integer",
"description": "Vertical coordinate in case of projected coordinates"
},
"Variable": {
"type": "string",
"description": "Observed variable",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ClimateGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Value",
"Unit",
"ValidFrom",
"ValidUntil",
"LocationType",
"Variable",
"ClimateGuid"
]
}2.2.2.1.5 Climate JSON data
{
"Experiment": "Historical",
"TemporalResolution": "monthly",
"SpatialResolution": "0.11 degree x 0.11 degree",
"GCM": "MPI-M-MPI-ESM-LR",
"RCM": "AWI-HIRHAM5",
"SimV": "Lorem",
"EnsM": "r1i1p1",
"Value": 28462827.85,
"Unit": "Celsius",
"ValidFrom": "2021-08-16 12:02:13",
"ValidUntil": "2022-08-19 00:00:00",
"LocationType": "Geographic coordinates",
"CoordinateSystem": "Lorem",
"Location": "DE27C",
"Lat": -63,
"Lon": 28,
"PosX": -46,
"PosY": 41,
"Variable": "HDD",
"ClimateGuid": "075a2983-a8e5-4ea8-a354-6a88b311bfdb"
}2.2.2.2 Document ClimateBuilding
2.2.2.2.1 ClimateBuilding Tree Diagram
2.2.2.2.2 ClimateBuilding Properties
| Property | Value |
| Document name | ClimateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.2.3 ClimateBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Climate Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.2.3.1 Field ClimateGuid
2.2.2.2.3.1.1 ClimateGuid properties
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Climate Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Climate |
| Foreign field | ClimateGuid |
| Relationship type | |
| Relationship name | New Relationship(32) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.2.3.2 Field BuildingId
2.2.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ClimateBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.2.4 ClimateBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateBuilding",
"properties": {
"ClimateGuid": {
"type": "string",
"description": "Climate Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateGuid",
"BuildingId"
]
}2.2.2.2.5 ClimateBuilding JSON data
{
"ClimateGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}2.2.2.3 Document ClimateSite
2.2.2.3.1 ClimateSite Tree Diagram
2.2.2.3.2 ClimateSite Properties
| Property | Value |
| Document name | ClimateSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.3.3 ClimateSite Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateGuid | string | true | Climate Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.3.3.1 Field ClimateGuid
2.2.2.3.3.1.1 ClimateGuid properties
| Property | Value |
| Name | ClimateGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Climate Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Climate |
| Foreign field | ClimateGuid |
| Relationship type | |
| Relationship name | New Relationship(31) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.3.3.2 Field SiteId
2.2.2.3.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to ClimateSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.2.2.3.4 ClimateSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateSite",
"properties": {
"ClimateGuid": {
"type": "string",
"description": "Climate Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateGuid",
"SiteId"
]
}2.2.2.3.5 ClimateSite JSON data
{
"ClimateGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}2.2.2.4 Document EmissionFactor
2.2.2.4.1 EmissionFactor Tree Diagram
2.2.2.4.2 EmissionFactor Properties
| Property | Value |
| Document name | EmissionFactor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
2.2.2.4.3 EmissionFactor Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Globally Unique Identifier number | ||
| Country | string | true | Country in which the emission factor is valid | ||
| Type | string | true | Type of resource consumption the emission factor refers to | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | true | Value of emission factor | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission factor in terms of kgCO2e per unit of resource consumption | ||
| Source | string | false | Source of emission factor e.g. 'International Energy Agency' | ||
| SpaceType | string | false | Differentiated emission factor for certain space type (within a building) | ||
| Region | string | false | |||
| City | string | false | |||
| Scenario | string | false | User specific emission factor scenario | ||
| OperationalMeasurementGuid | string | false | fk | Differentiated emission factor for certain operational measurement |
2.2.2.4.3.1 Field Country
2.2.2.4.3.1.1 Country properties
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Country in which the emission factor is valid |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Germany |
| Comments |
2.2.2.4.3.2 Field Type
2.2.2.4.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of resource consumption the emission factor refers to |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Natural gas (standard mix),Oil-based fuels,District heating,Water discharge,Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply |
| Sample | District heating |
| Comments |
2.2.2.4.3.3 Field ValidFrom
2.2.2.4.3.3.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-02-12 07:03:33 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.4.3.4 Field ValidUntil
2.2.2.4.3.4.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-03-21 11:25:21 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.4.3.5 Field Value
2.2.2.4.3.5.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of emission factor |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2638593.12 |
| Comments | [{"dataType":"float"}] |
2.2.2.4.3.6 Field Unit
2.2.2.4.3.6.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission factor in terms of kgCO2e per unit of resource consumption |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e/kWh,kgCO2e/kg,kgCO2e/m3 |
| Sample | kgCO2e/kg |
| Comments |
2.2.2.4.3.7 Field Source
2.2.2.4.3.7.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of emission factor e.g. 'International Energy Agency' |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | International Energy Agency |
| Comments |
2.2.2.4.3.8 Field SpaceType
2.2.2.4.3.8.1 SpaceType properties
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Differentiated emission factor for certain space type (within a building) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Sample | Landlord space |
| Comments |
2.2.2.4.3.9 Field Region
2.2.2.4.3.9.1 Region properties
| Property | Value |
| Name | Region |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bavaria |
| Comments |
2.2.2.4.3.10 Field City
2.2.2.4.3.10.1 City properties
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Berlin |
| Comments |
2.2.2.4.3.11 Field Scenario
2.2.2.4.3.11.1 Scenario properties
| Property | Value |
| Name | Scenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific emission factor scenario |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
2.2.2.4.3.12 Field OperationalMeasurementGuid
2.2.2.4.3.12.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Differentiated emission factor for certain operational measurement |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(18) |
| Cardinality | 1..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.4.3.13 Field EmissionFactorGuid
2.2.2.4.3.13.1 EmissionFactorGuid properties
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
2.2.2.4.4 EmissionFactor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactor",
"additionalProperties": false,
"properties": {
"Country": {
"type": "string",
"description": "Country in which the emission factor is valid",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of resource consumption the emission factor refers to",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Natural gas (standard mix)",
"Oil-based fuels",
"District heating",
"Water discharge",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of emission factor",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission factor in terms of kgCO2e per unit of resource consumption",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e/kWh",
"kgCO2e/kg",
"kgCO2e/m3"
]
},
"Source": {
"type": "string",
"description": "Source of emission factor e.g. 'International Energy Agency'",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceType": {
"type": "string",
"description": "Differentiated emission factor for certain space type (within a building)",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Region": {
"type": "string",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Scenario": {
"type": "string",
"description": "User specific emission factor scenario",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Differentiated emission factor for certain operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionFactorGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Country",
"Type",
"ValidFrom",
"ValidUntil",
"Value",
"EmissionFactorGuid"
]
}2.2.2.4.5 EmissionFactor JSON data
{
"Country": "Germany",
"Type": "District heating",
"ValidFrom": "2021-02-12 07:03:33",
"ValidUntil": "2022-03-21 11:25:21",
"Value": 2638593.12,
"Unit": "kgCO2e/kg",
"Source": "International Energy Agency",
"SpaceType": "Landlord space",
"Region": "Bavaria",
"City": "Berlin",
"Scenario": "BM default",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e"
}2.2.2.5 Document EmissionFactorBuilding
2.2.2.5.1 EmissionFactorBuilding Tree Diagram
2.2.2.5.2 EmissionFactorBuilding Properties
| Property | Value |
| Document name | EmissionFactorBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.5.3 EmissionFactorBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Emission Factor Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.5.3.1 Field EmissionFactorGuid
2.2.2.5.3.1.1 EmissionFactorGuid properties
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission Factor Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(22) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
2.2.2.5.3.2 Field SiteId
2.2.2.5.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to EmissionFactorBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.2.2.5.4 EmissionFactorBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorBuilding",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Emission Factor Globally Unique Identifier number",
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"SiteId"
]
}2.2.2.5.5 EmissionFactorBuilding JSON data
{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"SiteId": "AE-DE-02"
}2.2.2.6 Document EmissionFactorBusinessPartner
2.2.2.6.1 EmissionFactorBusinessPartner Tree Diagram
2.2.2.6.2 EmissionFactorBusinessPartner Properties
| Property | Value |
| Document name | EmissionFactorBusinessPartner |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.6.3 EmissionFactorBusinessPartner Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Globally Unique Identifier number | ||
| RoleId | string | true | Link to role |
2.2.2.6.3.1 Field EmissionFactorGuid
2.2.2.6.3.1.1 EmissionFactorGuid properties
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(33) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
2.2.2.6.3.2 Field RoleId
2.2.2.6.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to role |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OperationalMeasurement. |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.2.2.6.4 EmissionFactorBusinessPartner JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorBusinessPartner",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Link to role",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"RoleId"
]
}2.2.2.6.5 EmissionFactorBusinessPartner JSON data
{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"RoleId": "R-01"
}2.2.2.7 Document EmissionFactorSite
2.2.2.7.1 EmissionFactorSite Tree Diagram
2.2.2.7.2 EmissionFactorSite Properties
| Property | Value |
| Document name | EmissionFactorSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.7.3 EmissionFactorSite Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorGuid | string | true | Emission Factor Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.7.3.1 Field EmissionFactorGuid
2.2.2.7.3.1.1 EmissionFactorGuid properties
| Property | Value |
| Name | EmissionFactorGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission Factor Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorGuid |
| Relationship type | |
| Relationship name | New Relationship(21) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments |
2.2.2.7.3.2 Field BuildingId
2.2.2.7.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to EmissionFactorSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.7.4 EmissionFactorSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorSite",
"properties": {
"EmissionFactorGuid": {
"type": "string",
"description": "Emission Factor Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorGuid",
"BuildingId"
]
}2.2.2.7.5 EmissionFactorSite JSON data
{
"EmissionFactorGuid": "eb40c43b-8950-47b5-902f-0adac685f19e",
"BuildingId": "SE-CH-2341"
}2.2.2.8 Document GhgEmissions
2.2.2.8.1 GhgEmissions Tree Diagram
2.2.2.8.2 GhgEmissions Properties
| Property | Value |
| Document name | GhgEmissions |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
2.2.2.8.3 GhgEmissions Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | Globally Unique Identifier number | ||
| Name | string | false | Name of individual emission value (user-provided) | ||
| Parent | string | false | Parent (Guid) of individual emission value | ||
| EmissionScope | string | true | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol | ||
| ReportingType | string | true | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| Type | string | true | General source of emission e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| LCA | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| ProjectionBaseYear | date-time | false | Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of individual emission | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission value: kgCO2e | ||
| EmissionFactorScenario | string | false | User specific Emission Factor Scenario (BM default can be used) | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
| OperationalMeasurementGuid | string | false | fk | Identifier of related operational measurement |
2.2.2.8.3.1 Field Name
2.2.2.8.3.1.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual emission value (user-provided) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Biom¸ll |
| Comments |
2.2.2.8.3.2 Field Parent
2.2.2.8.3.2.1 Parent properties
| Property | Value |
| Name | Parent |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of individual emission value |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ef3f9faf-48c5-4609-ae0a-43340d9369c4 |
| Comments |
2.2.2.8.3.3 Field EmissionScope
2.2.2.8.3.3.1 EmissionScope properties
| Property | Value |
| Name | EmissionScope |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | 1,2,3,Unspecified |
| Sample | 2 |
| Comments |
2.2.2.8.3.4 Field ReportingType
2.2.2.8.3.4.1 ReportingType properties
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Location-based,Market-based,NA |
| Sample | Market-based |
| Comments |
2.2.2.8.3.5 Field Type
2.2.2.8.3.5.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General source of emission e.g. energy, water or waste |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,Fugitive,Waste,Water discharge,Water supply |
| Sample | Waste |
| Comments |
2.2.2.8.3.6 Field SubType
2.2.2.8.3.6.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District Cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water discharge,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Sample | Solar thermal |
| Comments |
2.2.2.8.3.7 Field LCA
2.2.2.8.3.7.1 LCA properties
| Property | Value |
| Name | LCA |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Sample | B4 |
| Comments |
2.2.2.8.3.8 Field ProjectionBaseYear
2.2.2.8.3.8.1 ProjectionBaseYear properties
| Property | Value |
| Name | ProjectionBaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-24 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.8.3.9 Field ValidFrom
2.2.2.8.3.9.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-06 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.8.3.10 Field ValidUntil
2.2.2.8.3.10.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-05-05 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.8.3.11 Field Value
2.2.2.8.3.11.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of individual emission |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 354678233.32 |
| Comments | [{"dataType":"float"}] |
2.2.2.8.3.12 Field Unit
2.2.2.8.3.12.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission value: kgCO2e |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e,NA |
| Sample | kgCO2e |
| Comments |
2.2.2.8.3.13 Field EmissionFactorScenario
2.2.2.8.3.13.1 EmissionFactorScenario properties
| Property | Value |
| Name | EmissionFactorScenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Emission Factor Scenario (BM default can be used) |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
2.2.2.8.3.14 Field Accuracy
2.2.2.8.3.14.1 Accuracy properties
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Calculated based on estimated data,Calculated based on metered data,Calculated based on extrapolated data,Calculated based on planed data,Calculated based on simulated data,Calculated based on data with unspecified accuracy,Calculated based on projected estimated data,Calculated based on projected metered data,Calculated based on projected extrapolated data,Calculated based on projected planned data,Calculated based on projected simulated data,Calculated based on projected data with unspecified accuracy,Estimated,Metered,Extrapolated,Planned,Unspecified,Simulated,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on data with unspecified accuracy,Projection based on simulated data,Missing |
| Sample | Missing |
| Comments |
2.2.2.8.3.15 Field OperationalMeasurementGuid
2.2.2.8.3.15.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of related operational measurement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | Foreign Key |
| Relationship name | New Relationship(19) |
| Cardinality | 1..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.8.3.16 Field GhgEmissionsGuid
2.2.2.8.3.16.1 GhgEmissionsGuid properties
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
2.2.2.8.4 GhgEmissions JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissions",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of individual emission value (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Parent": {
"type": "string",
"description": "Parent (Guid) of individual emission value",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionScope": {
"type": "string",
"description": "Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"1",
"2",
"3",
"Unspecified"
]
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based",
"NA"
]
},
"Type": {
"type": "string",
"description": "General source of emission e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Fugitive",
"Waste",
"Water discharge",
"Water supply"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District Cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water discharge",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"LCA": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"ProjectionBaseYear": {
"type": "string",
"description": "Base year of emissions projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of individual emission",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission value: kgCO2e",
"enum": [
"kgCO2e",
"NA"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EmissionFactorScenario": {
"type": "string",
"description": "User specific Emission Factor Scenario (BM default can be used)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Calculated based on estimated data",
"Calculated based on metered data",
"Calculated based on extrapolated data",
"Calculated based on planed data",
"Calculated based on simulated data",
"Calculated based on data with unspecified accuracy",
"Calculated based on projected estimated data",
"Calculated based on projected metered data",
"Calculated based on projected extrapolated data",
"Calculated based on projected planned data",
"Calculated based on projected simulated data",
"Calculated based on projected data with unspecified accuracy",
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Unspecified",
"Simulated",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on data with unspecified accuracy",
"Projection based on simulated data",
"Missing"
]
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Identifier of related operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"GhgEmissionsGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"EmissionScope",
"ReportingType",
"Type",
"SubType",
"ValidFrom",
"ValidUntil",
"Accuracy",
"GhgEmissionsGuid"
]
}2.2.2.8.5 GhgEmissions JSON data
{
"Name": "Biom¸ll",
"Parent": "ef3f9faf-48c5-4609-ae0a-43340d9369c4",
"EmissionScope": "2",
"ReportingType": "Market-based",
"Type": "Waste",
"SubType": "Solar thermal",
"LCA": "B4",
"ProjectionBaseYear": "2021-05-24 00:00:00",
"ValidFrom": "2021-04-06 00:00:00",
"ValidUntil": "2023-05-05 00:00:00",
"Value": 354678233.32,
"Unit": "kgCO2e",
"EmissionFactorScenario": "BM default",
"Accuracy": "Missing",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40"
}2.2.2.9 Document GhgEmissionsBuilding
2.2.2.9.1 GhgEmissionsBuilding Tree Diagram
2.2.2.9.2 GhgEmissionsBuilding Properties
| Property | Value |
| Document name | GhgEmissionsBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.9.3 GhgEmissionsBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | gHg Emissions Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.9.3.1 Field GhgEmissionsGuid
2.2.2.9.3.1.1 GhgEmissionsGuid properties
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | gHg Emissions Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | GhgEmissions |
| Foreign field | GhgEmissionsGuid |
| Relationship type | |
| Relationship name | New Relationship(24) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
2.2.2.9.3.2 Field BuildingId
2.2.2.9.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to gHgEmissionsBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.9.4 GhgEmissionsBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionsBuilding",
"properties": {
"GhgEmissionsGuid": {
"type": "string",
"description": "gHg Emissions Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionsGuid",
"BuildingId"
]
}2.2.2.9.5 GhgEmissionsBuilding JSON data
{
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"BuildingId": "SE-CH-2341"
}2.2.2.10 Document GhgEmissionsSite
2.2.2.10.1 GhgEmissionsSite Tree Diagram
2.2.2.10.2 GhgEmissionsSite Properties
| Property | Value |
| Document name | GhgEmissionsSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.10.3 GhgEmissionsSite Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionsGuid | string | true | gHg Emissions Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.10.3.1 Field GhgEmissionsGuid
2.2.2.10.3.1.1 GhgEmissionsGuid properties
| Property | Value |
| Name | GhgEmissionsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | gHg Emissions Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | GhgEmissions |
| Foreign field | GhgEmissionsGuid |
| Relationship type | |
| Relationship name | New Relationship(23) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments |
2.2.2.10.3.2 Field SiteId
2.2.2.10.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to gHgEmissionsSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.2.2.10.4 GhgEmissionsSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionsSite",
"properties": {
"GhgEmissionsGuid": {
"type": "string",
"description": "gHg Emissions Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionsGuid",
"SiteId"
]
}2.2.2.10.5 GhgEmissionsSite JSON data
{
"GhgEmissionsGuid": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"SiteId": "AE-DE-02"
}2.2.2.11 Document OperationalMeasurement
2.2.2.11.1 OperationalMeasurement Tree Diagram
2.2.2.11.2 OperationalMeasurement Properties
| Property | Value |
| Document name | OperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | false |
| Comments |
2.2.2.11.3 OperationalMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | dk | Globally Unique Identifier number | |
| Parent | string | false | Parent (Guid) of individual operational measurement | ||
| Purpose | string | true | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
| Type | string | true | General type of operational measurement e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| Name | string | false | Name of individual operational measurement. (user-provided) | ||
| Value | number | false | Value of individual operational measurement | [{"dataType":"float"}] | |
| Unit | string | false | Unit of operational measurement e.g. 'kWh' or 'm³' | ||
| ProcuredBy | string | true | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol | ||
| SpaceType | string | true | Reference to specific space type (or 'whole building') | ||
| LCA | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| PostingDate | date-time | false | Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| MeasurementDate | date-time | false | Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ProjectionBaseYear | date-time | false | Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| ProjectionBaseGuid | string | false | Identifier (Guid) of operational value projected into the future | Identifier (Guid) of operational value projected into the future | |
| MeterNumber | string | false | Name of meter providing value (user-provided) | ||
| MeterId | string | false | Identifier of meter providing value | ||
| RoleId | string | true | fk | Link to role |
2.2.2.11.3.1 Field Parent
2.2.2.11.3.1.1 Parent properties
| Property | Value |
| Name | Parent |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of individual operational measurement |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | c7175705-411f-4548-90d4-f58740fc2d30 |
| Comments |
2.2.2.11.3.2 Field Purpose
2.2.2.11.3.2.1 Purpose properties
| Property | Value |
| Name | Purpose |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Space heating,Water heating,Heating (unspecified),Cooling,Lighting,Elevator,Appliances,Other,Unspecified |
| Sample | Space heating |
| Comments |
2.2.2.11.3.3 Field Accuracy
2.2.2.11.3.3.1 Accuracy properties
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Estimated,Metered,Extrapolated,Planned,Simulated,Unspecified,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on simulated data,Projection based on data with unspecified accuracy,Missing |
| Sample | Extrapolated |
| Comments |
2.2.2.11.3.4 Field Type
2.2.2.11.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General type of operational measurement e.g. energy, water or waste |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,Water,Waste,Fugitive |
| Sample | Waste |
| Comments |
2.2.2.11.3.5 Field SubType
2.2.2.11.3.5.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District Cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water discharge,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Sample | Solar thermal |
| Comments |
2.2.2.11.3.6 Field Name
2.2.2.11.3.6.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual operational measurement. (user-provided) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.2.2.11.3.7 Field Value
2.2.2.11.3.7.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of individual operational measurement |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1234.3476 |
| Comments | [{"dataType":"float"}] |
2.2.2.11.3.8 Field Unit
2.2.2.11.3.8.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of operational measurement e.g. 'kWh' or 'm³' |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kWh,m³,kg |
| Sample | |
| Comments |
2.2.2.11.3.9 Field ProcuredBy
2.2.2.11.3.9.1 ProcuredBy properties
| Property | Value |
| Name | ProcuredBy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Procured by third party,Self-procured,Unspecified,NA |
| Sample | Self-procured |
| Comments |
2.2.2.11.3.10 Field SpaceType
2.2.2.11.3.10.1 SpaceType properties
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to specific space type (or 'whole building') |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Sample | Landlord space |
| Comments |
2.2.2.11.3.11 Field LCA
2.2.2.11.3.11.1 LCA properties
| Property | Value |
| Name | LCA |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Sample | B4 |
| Comments |
2.2.2.11.3.12 Field PostingDate
2.2.2.11.3.12.1 PostingDate properties
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-29 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.11.3.13 Field MeasurementDate
2.2.2.11.3.13.1 MeasurementDate properties
| Property | Value |
| Name | MeasurementDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-30 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.11.3.14 Field ValidFrom
2.2.2.11.3.14.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-07-05 13:21:21 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.11.3.15 Field ValidUntil
2.2.2.11.3.15.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-05-06 11:47:21 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.11.3.16 Field ProjectionBaseYear
2.2.2.11.3.16.1 ProjectionBaseYear properties
| Property | Value |
| Name | ProjectionBaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-09-21 21:29:56 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.11.3.17 Field ProjectionBaseGuid
2.2.2.11.3.17.1 ProjectionBaseGuid properties
| Property | Value |
| Name | ProjectionBaseGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier (Guid) of operational value projected into the future |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | Identifier (Guid) of operational value projected into the future |
2.2.2.11.3.18 Field MeterNumber
2.2.2.11.3.18.1 MeterNumber properties
| Property | Value |
| Name | MeterNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of meter providing value (user-provided) |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 201-Main Building |
| Comments |
2.2.2.11.3.19 Field MeterId
2.2.2.11.3.19.1 MeterId properties
| Property | Value |
| Name | MeterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of meter providing value |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.2.2.11.3.20 Field OperationalMeasurementGuid
2.2.2.11.3.20.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.11.3.21 Field RoleId
2.2.2.11.3.21.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to role |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to OperationalMeasurement. |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.2.2.11.4 OperationalMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurement",
"additionalProperties": false,
"properties": {
"Parent": {
"type": "string",
"description": "Parent (Guid) of individual operational measurement",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Purpose": {
"type": "string",
"description": "Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Space heating",
"Water heating",
"Heating (unspecified)",
"Cooling",
"Lighting",
"Elevator",
"Appliances",
"Other",
"Unspecified"
]
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Simulated",
"Unspecified",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on simulated data",
"Projection based on data with unspecified accuracy",
"Missing"
]
},
"Type": {
"type": "string",
"description": "General type of operational measurement e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Water",
"Waste",
"Fugitive"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District Cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water discharge",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"Name": {
"type": "string",
"description": "Name of individual operational measurement. (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of individual operational measurement",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of operational measurement e.g. 'kWh' or 'm³'",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kWh",
"m³",
"kg"
]
},
"ProcuredBy": {
"type": "string",
"description": "Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Procured by third party",
"Self-procured",
"Unspecified",
"NA"
]
},
"SpaceType": {
"type": "string",
"description": "Reference to specific space type (or 'whole building')",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LCA": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"PostingDate": {
"type": "string",
"description": "Date of measurement posting in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"MeasurementDate": {
"type": "string",
"description": "Date of measurement was taken in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ProjectionBaseYear": {
"type": "string",
"description": "Base year of operational value projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). If no exact date exists please use xxx-01-01 00:00:00.",
"format": "date-time",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"ProjectionBaseGuid": {
"type": "string",
"description": "Identifier (Guid) of operational value projected into the future",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"MeterNumber": {
"type": "string",
"description": "Name of meter providing value (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MeterId": {
"type": "string",
"description": "Identifier of meter providing value"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Link to role",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"Purpose",
"Accuracy",
"Type",
"SubType",
"ProcuredBy",
"SpaceType",
"ValidFrom",
"ValidUntil",
"OperationalMeasurementGuid",
"RoleId"
]
}2.2.2.11.5 OperationalMeasurement JSON data
{
"Parent": "c7175705-411f-4548-90d4-f58740fc2d30",
"Purpose": "Space heating",
"Accuracy": "Extrapolated",
"Type": "Waste",
"SubType": "Solar thermal",
"Name": "Lorem",
"Value": 1234.3476,
"Unit": "kg",
"ProcuredBy": "Self-procured",
"SpaceType": "Landlord space",
"LCA": "B4",
"PostingDate": "2021-04-29 00:00:00",
"MeasurementDate": "2020-09-30 00:00:00",
"ValidFrom": "2021-07-05 13:21:21",
"ValidUntil": "2021-05-06 11:47:21",
"ProjectionBaseYear": "2023-09-21 21:29:56",
"ProjectionBaseGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"MeterNumber": "201-Main Building",
"MeterId": "Lorem",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"RoleId": "R-01"
}2.2.2.12 Document OperationalMeasurementBuilding
2.2.2.12.1 OperationalMeasurementBuilding Tree Diagram
2.2.2.12.2 OperationalMeasurementBuilding Properties
| Property | Value |
| Document name | OperationalMeasurementBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.12.3 OperationalMeasurementBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.12.3.1 Field OperationalMeasurementGuid
2.2.2.12.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(27) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.12.3.2 Field BuildingId
2.2.2.12.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to OperationalMeasurementBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.12.4 OperationalMeasurementBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementBuilding",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"BuildingId"
]
}2.2.2.12.5 OperationalMeasurementBuilding JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}2.2.2.13 Document OperationalMeasurementFloor
2.2.2.13.1 OperationalMeasurementFloor Tree Diagram
2.2.2.13.2 OperationalMeasurementFloor Properties
| Property | Value |
| Document name | OperationalMeasurementFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.13.3 OperationalMeasurementFloor Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.13.3.1 Field OperationalMeasurementGuid
2.2.2.13.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(28) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.13.3.2 Field FloorId
2.2.2.13.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to OperationalMeasurementFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.2.2.13.4 OperationalMeasurementFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementFloor",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"FloorId"
]
}2.2.2.13.5 OperationalMeasurementFloor JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"FloorId": "SE-CH-F-01"
}2.2.2.14 Document OperationalMeasurementLand
2.2.2.14.1 OperationalMeasurementLand Tree Diagram
2.2.2.14.2 OperationalMeasurementLand Properties
| Property | Value |
| Document name | OperationalMeasurementLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.14.3 OperationalMeasurementLand Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.14.3.1 Field OperationalMeasurementGuid
2.2.2.14.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(26) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.14.3.2 Field LandId
2.2.2.14.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to OperationalMeasurementLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.2.2.14.4 OperationalMeasurementLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementLand",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"LandId"
]
}2.2.2.14.5 OperationalMeasurementLand JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"LandId": "RE-AT-05"
}2.2.2.15 Document OperationalMeasurementSite
2.2.2.15.1 OperationalMeasurementSite Tree Diagram
2.2.2.15.2 OperationalMeasurementSite Properties
| Property | Value |
| Document name | OperationalMeasurementSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.15.3 OperationalMeasurementSite Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.15.3.1 Field OperationalMeasurementGuid
2.2.2.15.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(25) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.15.3.2 Field SiteId
2.2.2.15.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to OperationalMeasurementSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.2.2.15.4 OperationalMeasurementSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSite",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"SiteId"
]
}2.2.2.15.5 OperationalMeasurementSite JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}2.2.2.16 Document OperationalMeasurementSpace
2.2.2.16.1 OperationalMeasurementSpace Tree Diagram
2.2.2.16.2 OperationalMeasurementSpace Properties
| Property | Value |
| Document name | OperationalMeasurementSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.16.3 OperationalMeasurementSpace Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| SpaceId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.2.2.16.3.1 Field OperationalMeasurementGuid
2.2.2.16.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(29) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.16.3.2 Field SpaceId
2.2.2.16.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to OperationalMeasurementSpace. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.2.2.16.4 OperationalMeasurementSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSpace",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"SpaceId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"SpaceId"
]
}2.2.2.16.5 OperationalMeasurementSpace JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"SpaceId": "SE-CH-F-01-21"
}2.2.2.17 Document OperationalMeasurementUnit
2.2.2.17.1 OperationalMeasurementUnit Tree Diagram
2.2.2.17.2 OperationalMeasurementUnit Properties
| Property | Value |
| Document name | OperationalMeasurementUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.17.3 OperationalMeasurementUnit Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementGuid | string | true | Operational Measurement Globally Unique Identifier number | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.17.3.1 Field OperationalMeasurementGuid
2.2.2.17.3.1.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational Measurement Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | New Relationship(28) |
| Cardinality | 0..1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.2.2.17.3.2 Field UnitId
2.2.2.17.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to OperationalMeasurementUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.2.2.17.4 OperationalMeasurementUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementUnit",
"properties": {
"OperationalMeasurementGuid": {
"type": "string",
"description": "Operational Measurement Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementGuid",
"UnitId"
]
}2.2.2.17.5 OperationalMeasurementUnit JSON data
{
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6",
"UnitId": "UN-SE-CH-2341-02"
}2.2.2.18 Document SustainabilityIndicators
2.2.2.18.1 SustainabilityIndicators Tree Diagram
2.2.2.18.2 SustainabilityIndicators Properties
| Property | Value |
| Document name | SustainabilityIndicators |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | EnergyAndResources |
| Additional properties | |
| Comments |
2.2.2.18.3 SustainabilityIndicators Fields
| Field | Type | Req | Key | Description | Comments |
| SustainabilityIndicatorsGuid | string | true | Globally Unique Identifier number | ||
| Category | string | true | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs | ||
| Type | string | true | Type of sustainability indicator e.g. absolute or intensity figures or stranding | ||
| Subtype | string | true | Subtype of sustainability indicator e.g. net-energy or emission scope | ||
| Source | string | true | Operational source of energy or emission figures e.g. electricity or water | ||
| ReferenceArea | string | true | Reference area of building used as denominator in intensity calculation | ||
| ReportingType | string | true | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| BaseYear | date-time | false | Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of sustainability indicator | [{"dataType":"float"}] | |
| EmissionFactorScenario | string | false | User specific emission factor scenario | ||
| Unit | string | true | Unit of sustainability indicator value | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| BuildingId | string | true | fk | Identifier of building |
2.2.2.18.3.1 Field Category
2.2.2.18.3.1.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Costs,Energy,Ghg |
| Sample | Energy |
| Comments |
2.2.2.18.3.2 Field Type
2.2.2.18.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of sustainability indicator e.g. absolute or intensity figures or stranding |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Absolute,Intensity,Excess emissions,Stranding,Target |
| Sample | Excess emissions |
| Comments |
2.2.2.18.3.3 Field Subtype
2.2.2.18.3.3.1 Subtype properties
| Property | Value |
| Name | Subtype |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of sustainability indicator e.g. net-energy or emission scope |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Total,Scope 1,Scope 2,Scope 3,Unspecified scope,Net energy,Consumption,Renewable on-site,Renewable including off-site,CRREM 1.5°C,CRREM 2°C |
| Sample | Unspecified scope |
| Comments |
2.2.2.18.3.4 Field Source
2.2.2.18.3.4.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational source of energy or emission figures e.g. electricity or water |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Energy,All,Fuels,Electricity,District heating,District cooling,Fugitive,Water supply,Water discharge,Water,Waste,NA |
| Sample | Electricity |
| Comments |
2.2.2.18.3.5 Field ReferenceArea
2.2.2.18.3.5.1 ReferenceArea properties
| Property | Value |
| Name | ReferenceArea |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference area of building used as denominator in intensity calculation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Net rentable area,Gross internal area,NA |
| Sample | Gross internal area |
| Comments |
2.2.2.18.3.6 Field ReportingType
2.2.2.18.3.6.1 ReportingType properties
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Location-based,Market-based,NA |
| Sample | Market-based |
| Comments |
2.2.2.18.3.7 Field BaseYear
2.2.2.18.3.7.1 BaseYear properties
| Property | Value |
| Name | BaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2022-01-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.18.3.8 Field Value
2.2.2.18.3.8.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of sustainability indicator |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 546372812.24 |
| Comments | [{"dataType":"float"}] |
2.2.2.18.3.9 Field EmissionFactorScenario
2.2.2.18.3.9.1 EmissionFactorScenario properties
| Property | Value |
| Name | EmissionFactorScenario |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific emission factor scenario |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM default |
| Comments |
2.2.2.18.3.10 Field Unit
2.2.2.18.3.10.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of sustainability indicator value |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | kgCO2e,kgCO2e/m²,kWh,kWh/m²,€,NA,m² |
| Sample | kWh/m² |
| Comments |
2.2.2.18.3.11 Field ValidFrom
2.2.2.18.3.11.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-01 11:34:45 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.18.3.12 Field ValidUntil
2.2.2.18.3.12.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2023-04-01 19:56:01 |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.18.3.13 Field BuildingId
2.2.2.18.3.13.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of building |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to SustainabilityIndicators. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.18.3.14 Field SustainabilityIndicatorsGuid
2.2.2.18.3.14.1 SustainabilityIndicatorsGuid properties
| Property | Value |
| Name | SustainabilityIndicatorsGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 8462d997-6fd2-439e-88d0-d3b2e19517c8 |
| Comments |
2.2.2.18.4 SustainabilityIndicators JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SustainabilityIndicators",
"properties": {
"Category": {
"type": "string",
"description": "Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Costs",
"Energy",
"Ghg"
]
},
"Type": {
"type": "string",
"description": "Type of sustainability indicator e.g. absolute or intensity figures or stranding",
"enum": [
"Absolute",
"Intensity",
"Excess emissions",
"Stranding",
"Target"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Subtype": {
"type": "string",
"description": "Subtype of sustainability indicator e.g. net-energy or emission scope",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Total",
"Scope 1",
"Scope 2",
"Scope 3",
"Unspecified scope",
"Net energy",
"Consumption",
"Renewable on-site",
"Renewable including off-site",
"CRREM 1.5°C",
"CRREM 2°C"
]
},
"Source": {
"type": "string",
"description": "Operational source of energy or emission figures e.g. electricity or water",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"All",
"Fuels",
"Electricity",
"District heating",
"District cooling",
"Fugitive",
"Water supply",
"Water discharge",
"Water",
"Waste",
"NA"
]
},
"ReferenceArea": {
"type": "string",
"description": "Reference area of building used as denominator in intensity calculation",
"enum": [
"Net rentable area",
"Gross internal area",
"NA"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based",
"NA"
]
},
"BaseYear": {
"type": "string",
"description": "Base year of values projected into the future in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00.",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of sustainability indicator",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"EmissionFactorScenario": {
"type": "string",
"description": "User specific emission factor scenario",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Unit": {
"type": "string",
"description": "Unit of sustainability indicator value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e",
"kgCO2e/m²",
"kWh",
"kWh/m²",
"€",
"NA",
"m²"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time"
},
"BuildingId": {
"type": "string",
"description": "Identifier of building",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SustainabilityIndicatorsGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 1,
"maxLength": 40,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"Category",
"Type",
"Subtype",
"Source",
"ReferenceArea",
"ReportingType",
"Unit",
"ValidFrom",
"ValidUntil",
"BuildingId",
"SustainabilityIndicatorsGuid"
]
}2.2.2.18.5 SustainabilityIndicators JSON data
{
"Category": "Energy",
"Type": "Excess emissions",
"Subtype": "Unspecified scope",
"Source": "Electricity",
"ReferenceArea": "Gross internal area",
"ReportingType": "Market-based",
"BaseYear": "2022-01-01 00:00:00",
"Value": 546372812.24,
"EmissionFactorScenario": "BM default",
"Unit": "kWh/m²",
"ValidFrom": "2021-03-01 11:34:45",
"ValidUntil": "2023-04-01 19:56:01",
"BuildingId": "SE-CH-2341",
"SustainabilityIndicatorsGuid": "8462d997-6fd2-439e-88d0-d3b2e19517c8"
}2.3 Group Financials
2.3.1 Financials Properties
| Property | Value |
| Group name | Financials |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.3.2 Financials Documents
2.3.2.1 Document Account
2.3.2.1.1 Account Tree Diagram
2.3.2.1.2 Account Properties
| Property | Value |
| Document name | Account |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.1.3 Account Fields
| Field | Type | Req | Key | Description | Comments |
| AccountId | string | true | dk | Account number | |
| Name | string | true | Account name | ||
| Project | string | true | Account Type (project aligned with RICS naming convention) | ||
| Category | string | true | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) | ||
| Group | string | true | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| Version | string | true | Account version |
2.3.2.1.3.1 Field AccountId
2.3.2.1.3.1.1 AccountId properties
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1100132415 |
| Comments |
2.3.2.1.3.2 Field Name
2.3.2.1.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account name |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Expenditures |
| Comments |
2.3.2.1.3.3 Field Project
2.3.2.1.3.3.1 Project properties
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account Type (project aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Assets,Liabilities,Equity,Revenue,Expenses,Other (Non-Operating) Income and expenses |
| Sample | Assets |
| Comments |
2.3.2.1.3.4 Field Category
2.3.2.1.3.4.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Costs |
| Comments |
2.3.2.1.3.5 Field Group
2.3.2.1.3.5.1 Group properties
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equipment |
| Comments |
2.3.2.1.3.6 Field ValidFrom
2.3.2.1.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-12-31 12:01:59 |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.1.3.7 Field ValidUntil
2.3.2.1.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2035-09-21 12:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.1.3.8 Field StatementType
2.3.2.1.3.8.1 StatementType properties
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | BalanceStatement,P&L |
| Sample | P&L |
| Comments |
2.3.2.1.3.9 Field RecordType
2.3.2.1.3.9.1 RecordType properties
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Debit,Credit |
| Sample | Debit |
| Comments |
2.3.2.1.3.10 Field Version
2.3.2.1.3.10.1 Version properties
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account version |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 01.1 |
| Comments |
2.3.2.1.4 Account JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Account",
"properties": {
"AccountId": {
"type": "string",
"description": "Account number",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"Name": {
"type": "string",
"description": "Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Account Type (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Assets",
"Liabilities",
"Equity",
"Revenue",
"Expenses",
"Other (Non-Operating) Income and expenses"
],
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Account category according to IBPDI charts of accounts (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Account group according IBPDI charts of accounts (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"Version": {
"type": "string",
"description": "Account version",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AccountId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version"
]
}2.3.2.1.5 Account JSON data
{
"AccountId": "1100132415",
"Name": "Maintenance Expenditures",
"Project": "Assets",
"Category": "Costs",
"Group": "Equipment",
"ValidFrom": "2021-12-31 12:01:59",
"ValidUntil": "2035-09-21 12:00:00",
"StatementType": "P&L",
"RecordType": "Debit",
"Version": "01.1"
}2.3.2.2 Document CostCenter
2.3.2.2.1 CostCenter Tree Diagram
2.3.2.2.2 CostCenter Properties
| Property | Value |
| Document name | CostCenter |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.2.3 CostCenter Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | dk | Internal paying party name/code | |
| Name | string | true | Name of cost center | ||
| Type | string | false | Type of cost center | ||
| Value | number | false | Value of cost center | [{"dataType":"float"}] | |
| IndividualAccountId | string | true | fk | Link to individual account | |
| OrganisationId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.2.3.1 Field CostCenterId
2.3.2.2.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Internal paying party name/code |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.2.3.2 Field Name
2.3.2.2.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of cost center |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service Cost Center |
| Comments |
2.3.2.2.3.3 Field Type
2.3.2.2.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of cost center |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service |
| Comments |
2.3.2.2.3.4 Field Value
2.3.2.2.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of cost center |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999 |
| Excl min | |
| Max value | 999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 24152.21 |
| Comments | [{"dataType":"float"}] |
2.3.2.2.3.5 Field IndividualAccountId
2.3.2.2.3.5.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to individual account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to CostCenter. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.3.2.2.3.6 Field OrganisationId
2.3.2.2.3.6.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to CostCenter. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.3.2.2.4 CostCenter JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenter",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Internal paying party name/code",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of cost center",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of cost center",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of cost center",
"minimum": -999999999,
"maximum": 999999999
},
"IndividualAccountId": {
"type": "string",
"description": "Link to individual account",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"Name",
"IndividualAccountId"
]
}2.3.2.2.5 CostCenter JSON data
{
"CostCenterId": "189000006",
"Name": "Service Cost Center",
"Type": "Service",
"Value": 24152.21,
"IndividualAccountId": "1890627182",
"OrganisationId": "BM2016271"
}2.3.2.3 Document CostCenterBuilding
2.3.2.3.1 CostCenterBuilding Tree Diagram
2.3.2.3.2 CostCenterBuilding Properties
| Property | Value |
| Document name | CostCenterBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.3.3 CostCenterBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.3.3.1 Field CostCenterId
2.3.2.3.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(36) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.3.3.2 Field BuildingId
2.3.2.3.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to CostCenterBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.3.2.3.4 CostCenterBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterBuilding",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"BuildingId"
]
}2.3.2.3.5 CostCenterBuilding JSON data
{
"CostCenterId": "189000006",
"BuildingId": "SE-CH-2341"
}2.3.2.4 Document CostCenterPortfolio
2.3.2.4.1 CostCenterPortfolio Tree Diagram
2.3.2.4.2 CostCenterPortfolio Properties
| Property | Value |
| Document name | CostCenterPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.4.3 CostCenterPortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.4.3.1 Field CostCenterId
2.3.2.4.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(34) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.4.3.2 Field PortfolioId
2.3.2.4.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to CostCenterPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.3.2.4.4 CostCenterPortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterPortfolio",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"PortfolioId"
]
}2.3.2.4.5 CostCenterPortfolio JSON data
{
"CostCenterId": "189000006",
"PortfolioId": "PF-03-01"
}2.3.2.5 Document CostCenterRentalUnit
2.3.2.5.1 CostCenterRentalUnit Tree Diagram
2.3.2.5.2 CostCenterRentalUnit Properties
| Property | Value |
| Document name | CostCenterRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.5.3 CostCenterRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.5.3.1 Field CostCenterId
2.3.2.5.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(37) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.5.3.2 Field RentalUnitId
2.3.2.5.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | |
| Relationship type | |
| Relationship name | fk RentalUnit. to CostCenterRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.3.2.5.4 CostCenterRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterRentalUnit",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"RentalUnitId"
]
}2.3.2.5.5 CostCenterRentalUnit JSON data
{
"CostCenterId": "189000006",
"RentalUnitId": "B-RU-10293"
}2.3.2.6 Document CostCenterSite
2.3.2.6.1 CostCenterSite Tree Diagram
2.3.2.6.2 CostCenterSite Properties
| Property | Value |
| Document name | CostCenterSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.6.3 CostCenterSite Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.6.3.1 Field CostCenterId
2.3.2.6.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | |
| Relationship name | New Relationship(35) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.6.3.2 Field SiteId
2.3.2.6.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to CostCenterSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.3.2.6.4 CostCenterSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterSite",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"SiteId"
]
}2.3.2.6.5 CostCenterSite JSON data
{
"CostCenterId": "189000006",
"SiteId": "AE-DE-02"
}2.3.2.7 Document IndividualAccount
2.3.2.7.1 IndividualAccount Tree Diagram
2.3.2.7.2 IndividualAccount Properties
| Property | Value |
| Document name | IndividualAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.7.3 IndividualAccount Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | dk | Individual Account number | |
| Name | string | true | Individual Account name | ||
| Project | string | true | Individual Account project (project aligned with RICS naming convention) | ||
| Category | string | true | Individual Account category (category aligned with RICS naming convention) | ||
| Group | string | true | Individual Account group (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| GAAP | string | false | GAAP type used (if applicable) | ||
| Version | string | true | Individual account version | ||
| AccountId | string | true | fk | Reference to account | |
| OrganisationId | string | true | fk | Reference to organisation |
2.3.2.7.3.1 Field IndividualAccountId
2.3.2.7.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.3.2.7.3.2 Field Name
2.3.2.7.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account name |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Costs |
| Comments |
2.3.2.7.3.3 Field Project
2.3.2.7.3.3.1 Project properties
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account project (project aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Expenditures |
| Comments |
2.3.2.7.3.4 Field Category
2.3.2.7.3.4.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account category (category aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Maintenance Costs |
| Comments |
2.3.2.7.3.5 Field Group
2.3.2.7.3.5.1 Group properties
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account group (group aligned with RICS naming convention) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equipment |
| Comments |
2.3.2.7.3.6 Field ValidFrom
2.3.2.7.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.7.3.7 Field ValidUntil
2.3.2.7.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2035-09-21 12:12:34 |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.7.3.8 Field StatementType
2.3.2.7.3.8.1 StatementType properties
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | BalanceStatement,P&L |
| Sample | P&L |
| Comments |
2.3.2.7.3.9 Field RecordType
2.3.2.7.3.9.1 RecordType properties
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Debit,Credit |
| Sample | Debit |
| Comments |
2.3.2.7.3.10 Field GAAP
2.3.2.7.3.10.1 GAAP properties
| Property | Value |
| Name | GAAP |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | GAAP type used (if applicable) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | IFRS |
| Comments |
2.3.2.7.3.11 Field Version
2.3.2.7.3.11.1 Version properties
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual account version |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 01.1 |
| Comments |
2.3.2.7.3.12 Field AccountId
2.3.2.7.3.12.1 AccountId properties
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Account |
| Foreign field | AccountId |
| Relationship type | Foreign Key |
| Relationship name | fk Account. to IndividualAccount. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1100132415 |
| Comments |
2.3.2.7.3.13 Field OrganisationId
2.3.2.7.3.13.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to organisation |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to AccountOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.3.2.7.4 IndividualAccount JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccount",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Individual Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Individual Account project (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Individual Account category (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Individual Account group (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"GAAP": {
"type": "string",
"description": "GAAP type used (if applicable)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Version": {
"type": "string",
"description": "Individual account version",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountId": {
"type": "string",
"description": "Reference to account",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"OrganisationId": {
"type": "string",
"description": "Reference to organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version",
"AccountId",
"OrganisationId"
]
}2.3.2.7.5 IndividualAccount JSON data
{
"IndividualAccountId": "1890627182",
"Name": "Maintenance Costs",
"Project": "Expenditures",
"Category": "Maintenance Costs",
"Group": "Equipment",
"ValidFrom": "2021-03-21 00:00:00",
"ValidUntil": "2035-09-21 12:12:34",
"StatementType": "P&L",
"RecordType": "Debit",
"GAAP": "IFRS",
"Version": "01.1",
"AccountId": "1100132415",
"OrganisationId": "BM2016271"
}2.3.2.8 Document IndividualAccountBuilding
2.3.2.8.1 IndividualAccountBuilding Tree Diagram
2.3.2.8.2 IndividualAccountBuilding Properties
| Property | Value |
| Document name | IndividualAccountBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.8.3 IndividualAccountBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| BuildingId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.8.3.1 Field IndividualAccountId
2.3.2.8.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to TransactionBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.3.2.8.3.2 Field BuildingId
2.3.2.8.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to TransactionBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.3.2.8.4 IndividualAccountBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountBuilding",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"BuildingId"
]
}2.3.2.8.5 IndividualAccountBuilding JSON data
{
"IndividualAccountId": "1890627182",
"BuildingId": "SE-CH-2341"
}2.3.2.9 Document IndividualAccountPortfolio
2.3.2.9.1 IndividualAccountPortfolio Tree Diagram
2.3.2.9.2 IndividualAccountPortfolio Properties
| Property | Value |
| Document name | IndividualAccountPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.9.3 IndividualAccountPortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.9.3.1 Field IndividualAccountId
2.3.2.9.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.3.2.9.3.2 Field PortfolioId
2.3.2.9.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to TransactionPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.3.2.9.4 IndividualAccountPortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountPortfolio",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"PortfolioId"
]
}2.3.2.9.5 IndividualAccountPortfolio JSON data
{
"IndividualAccountId": "1890627182",
"PortfolioId": "PF-03-01"
}2.3.2.10 Document IndividualAccountSite
2.3.2.10.1 IndividualAccountSite Tree Diagram
2.3.2.10.2 IndividualAccountSite Properties
| Property | Value |
| Document name | IndividualAccountSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.10.3 IndividualAccountSite Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Individual Account number | |
| SiteId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.3.2.10.3.1 Field IndividualAccountId
2.3.2.10.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to TransactionSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.3.2.10.3.2 Field SiteId
2.3.2.10.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to TransactionSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.3.2.10.4 IndividualAccountSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountSite",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"SiteId"
]
}2.3.2.10.5 IndividualAccountSite JSON data
{
"IndividualAccountId": "1890627182",
"SiteId": "AE-DE-02"
}2.3.2.11 Document Transaction
2.3.2.11.1 Transaction Tree Diagram
2.3.2.11.2 Transaction Properties
| Property | Value |
| Document name | Transaction |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | Financials |
| Additional properties | |
| Comments |
2.3.2.11.3 Transaction Fields
| Field | Type | Req | Key | Description | Comments |
| TransactionId | string | true | Transaction number | ||
| Type | string | true | Type of transaction | ||
| BookingType | string | true | Booking type | ||
| Value | number | true | Cost/Income value of specific transaction | [{"dataType":"float"}] | |
| BookingCurrency | string | true | Currency of booking | ||
| PostingDate | date-time | true | Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| DocumentId | string | false | Reference to document | does not exist yet | |
| CostCenterId | string | true | fk | Reference to cost center |
2.3.2.11.3.1 Field TransactionId
2.3.2.11.3.1.1 TransactionId properties
| Property | Value |
| Name | TransactionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Transaction number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 887332968 |
| Comments |
2.3.2.11.3.2 Field Type
2.3.2.11.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of transaction |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | Actual,Budget,Forecast |
| Sample | Actual |
| Comments |
2.3.2.11.3.3 Field BookingType
2.3.2.11.3.3.1 BookingType properties
| Property | Value |
| Name | BookingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Booking type |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | debit,credit |
| Sample | debit |
| Comments |
2.3.2.11.3.4 Field Value
2.3.2.11.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Cost/Income value of specific transaction |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999 |
| Excl min | |
| Max value | 999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 1381 |
| Comments | [{"dataType":"float"}] |
2.3.2.11.3.5 Field BookingCurrency
2.3.2.11.3.5.1 BookingCurrency properties
| Property | Value |
| Name | BookingCurrency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of booking |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.3.2.11.3.6 Field PostingDate
2.3.2.11.3.6.1 PostingDate properties
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-04-07 12:11:34 |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.11.3.7 Field DocumentId
2.3.2.11.3.7.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
2.3.2.11.3.8 Field CostCenterId
2.3.2.11.3.8.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to cost center |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to Transaction. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 189000006 |
| Comments |
2.3.2.11.4 Transaction JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Transaction",
"properties": {
"TransactionId": {
"type": "string",
"description": "Transaction number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of transaction",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Actual",
"Budget",
"Forecast"
]
},
"BookingType": {
"type": "string",
"description": "Booking type",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"debit",
"credit"
]
},
"Value": {
"type": "number",
"description": "Cost/Income value of specific transaction",
"minimum": -999999999,
"maximum": 999999999
},
"BookingCurrency": {
"type": "string",
"description": "Currency of booking",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PostingDate": {
"type": "string",
"description": "Date transaction is posted in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$"
},
"DocumentId": {
"type": "string",
"description": "Reference to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CostCenterId": {
"type": "string",
"description": "Reference to cost center",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TransactionId",
"Type",
"BookingType",
"Value",
"BookingCurrency",
"PostingDate",
"CostCenterId"
]
}2.3.2.11.5 Transaction JSON data
{
"TransactionId": "887332968",
"Type": "Actual",
"BookingType": "debit",
"Value": 1381,
"BookingCurrency": "Euro",
"PostingDate": "2021-04-07 12:11:34",
"DocumentId": "Lorem",
"CostCenterId": "189000006"
}2.4 Group OrganisationalManagement
2.4.1 OrganisationalManagement Properties
| Property | Value |
| Group name | OrganisationalManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.4.2 OrganisationalManagement Documents
2.4.2.1 Document Address
2.4.2.1.1 Address Tree Diagram
2.4.2.1.2 Address Properties
| Property | Value |
| Document name | Address |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | false |
| Comments |
2.4.2.1.3 Address Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of address | ||
| StreetName | string | true | Name of the street | ||
| HouseNumber | string | false | House number of the street | ||
| AdditionalInformation | string | false | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. | ||
| Appartment/Unit | string | false | Unit number | ||
| District | string | false | Boroughs or districts within a city that serve some official purpose | ||
| City | string | true | Any official settlement including cities, towns, villages, hamlets, localities, etc. | ||
| PostalCode | string | false | Postal codes used for mail sorting | ||
| StateProvincePrefecture | string | false | First-level administrative division, depending on the continent or country if might be named differently. | ||
| Country | string | true | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
2.4.2.1.3.1 Field AddressId
2.4.2.1.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.1.3.2 Field Type
2.4.2.1.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of address |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Postal address |
| Comments |
2.4.2.1.3.3 Field StreetName
2.4.2.1.3.3.1 StreetName properties
| Property | Value |
| Name | StreetName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of the street |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 128 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Friedrichsstraße |
| Comments |
2.4.2.1.3.4 Field HouseNumber
2.4.2.1.3.4.1 HouseNumber properties
| Property | Value |
| Name | HouseNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | House number of the street |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 32 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 78a |
| Comments |
2.4.2.1.3.5 Field AdditionalInformation
2.4.2.1.3.5.1 AdditionalInformation properties
| Property | Value |
| Name | AdditionalInformation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Building A |
| Comments |
2.4.2.1.3.6 Field Appartment/Unit
2.4.2.1.3.6.1 Appartment/Unit properties
| Property | Value |
| Name | Appartment/Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit number |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | C602 |
| Comments |
2.4.2.1.3.7 Field District
2.4.2.1.3.7.1 District properties
| Property | Value |
| Name | District |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Boroughs or districts within a city that serve some official purpose |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Brooklyn |
| Comments |
2.4.2.1.3.8 Field City
2.4.2.1.3.8.1 City properties
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Any official settlement including cities, towns, villages, hamlets, localities, etc. |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Berlin |
| Comments |
2.4.2.1.3.9 Field PostalCode
2.4.2.1.3.9.1 PostalCode properties
| Property | Value |
| Name | PostalCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Postal codes used for mail sorting |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 10 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 10117 |
| Comments |
2.4.2.1.3.10 Field StateProvincePrefecture
2.4.2.1.3.10.1 StateProvincePrefecture properties
| Property | Value |
| Name | StateProvincePrefecture |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First-level administrative division, depending on the continent or country if might be named differently. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Bayern |
| Comments |
2.4.2.1.3.11 Field Country
2.4.2.1.3.11.1 Country properties
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Germany |
| Comments |
2.4.2.1.4 Address JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Address",
"additionalProperties": false,
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of address",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StreetName": {
"type": "string",
"description": "Name of the street",
"minLength": 1,
"maxLength": 128,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"HouseNumber": {
"type": "string",
"description": "House number of the street",
"minLength": 1,
"maxLength": 32,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AdditionalInformation": {
"type": "string",
"description": "Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. ",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Appartment/Unit": {
"type": "string",
"description": "Unit number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"District": {
"type": "string",
"description": "Boroughs or districts within a city that serve some official purpose",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"description": "Any official settlement including cities, towns, villages, hamlets, localities, etc.",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PostalCode": {
"type": "string",
"description": "Postal codes used for mail sorting",
"minLength": 1,
"maxLength": 10,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StateProvincePrefecture": {
"type": "string",
"description": " First-level administrative division, depending on the continent or country if might be named differently.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Country": {
"type": "string",
"description": "Sovereign nations and their dependent territories, anything with an ISO-3166 code",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"Type",
"StreetName",
"City",
"Country"
]
}2.4.2.1.5 Address JSON data
{
"AddressId": "AD-9281928",
"Type": "Postal address",
"StreetName": "Friedrichsstraße",
"HouseNumber": "78a",
"AdditionalInformation": "Building A",
"Appartment/Unit": "C602",
"District": "Brooklyn",
"City": "Berlin",
"PostalCode": "10117",
"StateProvincePrefecture": "Bayern",
"Country": "Germany"
}2.4.2.2 Document AddressBuilding
2.4.2.2.1 AddressBuilding Tree Diagram
2.4.2.2.2 AddressBuilding Properties
| Property | Value |
| Document name | AddressBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.2.3 AddressBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.2.3.1 Field AddressId
2.4.2.2.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(51) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.2.3.2 Field BuildingId
2.4.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to AddressBuilding. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.4.2.2.4 AddressBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressBuilding",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"AddressId",
"BuildingId"
]
}2.4.2.2.5 AddressBuilding JSON data
{
"AddressId": "AD-9281928",
"BuildingId": "SE-CH-2341"
}2.4.2.3 Document AddressContact
2.4.2.3.1 AddressContact Tree Diagram
2.4.2.3.2 AddressContact Properties
| Property | Value |
| Document name | AddressContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.3.3 AddressContact Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.3.3.1 Field AddressId
2.4.2.3.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | fk Address. to AddressContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.3.3.2 Field ContactId
2.4.2.3.3.2.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Contact |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Contact. to AddressContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
2.4.2.3.4 AddressContact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressContact",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"ContactId"
]
}2.4.2.3.5 AddressContact JSON data
{
"AddressId": "AD-9281928",
"ContactId": "BP-00441"
}2.4.2.4 Document AddressLand
2.4.2.4.1 AddressLand Tree Diagram
2.4.2.4.2 AddressLand Properties
| Property | Value |
| Document name | AddressLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.4.3 AddressLand Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.4.3.1 Field AddressId
2.4.2.4.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(54) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.4.3.2 Field LandId
2.4.2.4.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to AddressLand. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.4.2.4.4 AddressLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressLand",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"LandId"
]
}2.4.2.4.5 AddressLand JSON data
{
"AddressId": "AD-9281928",
"LandId": "RE-AT-05"
}2.4.2.5 Document AddressOrganisation
2.4.2.5.1 AddressOrganisation Tree Diagram
2.4.2.5.2 AddressOrganisation Properties
| Property | Value |
| Document name | AddressOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.5.3 AddressOrganisation Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| OrganisationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.5.3.1 Field AddressId
2.4.2.5.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | fk Address. to AddressOrganisation. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.5.3.2 Field OrganisationId
2.4.2.5.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | |
| Relationship name | fk Organisation. to AddressOrganisation. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.4.2.5.4 AddressOrganisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressOrganisation",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"OrganisationId"
]
}2.4.2.5.5 AddressOrganisation JSON data
{
"AddressId": "AD-9281928",
"OrganisationId": "BM2016271"
}2.4.2.6 Document AddressRentalUnit
2.4.2.6.1 AddressRentalUnit Tree Diagram
2.4.2.6.2 AddressRentalUnit Properties
| Property | Value |
| Document name | AddressRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.6.3 AddressRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.6.3.1 Field AddressId
2.4.2.6.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(52) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.6.3.2 Field RentalUnitId
2.4.2.6.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | |
| Relationship type | |
| Relationship name | fk RentalUnit. to AddressRentalUnit. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.4.2.6.4 AddressRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressRentalUnit",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"RentalUnitId"
]
}2.4.2.6.5 AddressRentalUnit JSON data
{
"AddressId": "AD-9281928",
"RentalUnitId": "B-RU-10293"
}2.4.2.7 Document AddressSite
2.4.2.7.1 AddressSite Tree Diagram
2.4.2.7.2 AddressSite Properties
| Property | Value |
| Document name | AddressSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.7.3 AddressSite Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.7.3.1 Field AddressId
2.4.2.7.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | |
| Relationship name | New Relationship(50) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AD-9281928 |
| Comments |
2.4.2.7.3.2 Field SiteId
2.4.2.7.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to AddressSite. |
| Cardinality | 1 |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.4.2.7.4 AddressSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressSite",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"SiteId"
]
}2.4.2.7.5 AddressSite JSON data
{
"AddressId": "AD-9281928",
"SiteId": "AE-DE-02"
}2.4.2.8 Document Contact
2.4.2.8.1 Contact Tree Diagram
2.4.2.8.2 Contact Properties
| Property | Value |
| Document name | Contact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | false |
| Comments |
2.4.2.8.3 Contact Fields
| Field | Type | Req | Key | Description | Comments |
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Salutation | string | false | Title of Business Partner | ||
| JobTitle | string | false | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns | ||
| FirstName | string | true | First Name of Business Partner or responsible contact person | ||
| LastName | string | true | Surname of Business Partner or responsible contact person | ||
| EmployeeId | string | false | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation | ||
| false | |||||
| Telephone | string | false | Phone number of business partner/ contact person | ||
| Fax | string | false | Fax number of business partner/ contact person | ||
| ValidFrom | date-time | false | For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| OrganisationId | string | false | fk | Link to organisation |
2.4.2.8.3.1 Field ContactId
2.4.2.8.3.1.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
2.4.2.8.3.2 Field Salutation
2.4.2.8.3.2.1 Salutation properties
| Property | Value |
| Name | Salutation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Title of Business Partner |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Dipl. -Ing. |
| Comments |
2.4.2.8.3.3 Field JobTitle
2.4.2.8.3.3.1 JobTitle properties
| Property | Value |
| Name | JobTitle |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Head of sales |
| Comments |
2.4.2.8.3.4 Field FirstName
2.4.2.8.3.4.1 FirstName properties
| Property | Value |
| Name | FirstName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First Name of Business Partner or responsible contact person |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Randolph |
| Comments |
2.4.2.8.3.5 Field LastName
2.4.2.8.3.5.1 LastName properties
| Property | Value |
| Name | LastName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Surname of Business Partner or responsible contact person |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Müller |
| Comments |
2.4.2.8.3.6 Field EmployeeId
2.4.2.8.3.6.1 EmployeeId properties
| Property | Value |
| Name | EmployeeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | E-172831 |
| Comments |
2.4.2.8.3.7 Field Email
2.4.2.8.3.7.1 Email properties
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | mueller@google.com |
| Comments |
2.4.2.8.3.8 Field Telephone
2.4.2.8.3.8.1 Telephone properties
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of business partner/ contact person |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 017663425123 |
| Comments |
2.4.2.8.3.9 Field Fax
2.4.2.8.3.9.1 Fax properties
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of business partner/ contact person |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 22228888 |
| Comments |
2.4.2.8.3.10 Field ValidFrom
2.4.2.8.3.10.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.8.3.11 Field ValidUntil
2.4.2.8.3.11.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2199-12-31 12:21:12 |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.8.3.12 Field OrganisationId
2.4.2.8.3.12.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to organisation |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to Contact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.4.2.8.4 Contact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Contact",
"additionalProperties": false,
"properties": {
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Salutation": {
"type": "string",
"description": "Title of Business Partner",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JobTitle": {
"type": "string",
"description": "Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FirstName": {
"type": "string",
"description": "First Name of Business Partner or responsible contact person",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LastName": {
"type": "string",
"description": "Surname of Business Partner or responsible contact person",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 100
},
"EmployeeId": {
"type": "string",
"description": "Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of business partner/ contact person",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Fax": {
"type": "string",
"description": "Fax number of business partner/ contact person",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "For internal reference to recored employed since in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "For internal reference to recored employed until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"OrganisationId": {
"type": "string",
"description": "Link to organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ContactId",
"FirstName",
"LastName"
]
}2.4.2.8.5 Contact JSON data
{
"ContactId": "BP-00441",
"Salutation": "Dipl. -Ing.",
"JobTitle": "Head of sales",
"FirstName": "Randolph",
"LastName": "Müller",
"EmployeeId": "E-172831",
"Email": "mueller@google.com",
"Telephone": "017663425123",
"Fax": "22228888",
"ValidFrom": "2021-03-21 00:00:00",
"ValidUntil": "2199-12-31 12:21:12",
"OrganisationId": "BM2016271"
}2.4.2.9 Document Organisation
2.4.2.9.1 Organisation Tree Diagram
2.4.2.9.2 Organisation Properties
| Property | Value |
| Document name | Organisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.9.3 Organisation Fields
| Field | Type | Req | Key | Description | Comments |
| OrganisationId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ParentOrganisationId | string | false | Link to parent organisation | ||
| Name | string | true | Name of organization | ||
| Industry | string | false | Industry of organisation | ||
| false | Email of organisation | ||||
| Telephone | string | false | Phone number of organisation | ||
| Fax | string | false | Fax number of organisation | ||
| VatNumber | string | true | Vat number of organisation | ||
| LegalEntity | boolean | true | Is the organisation an legal entity (Y/N) | ||
| FiscalYearStartDate | date-time | true | Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.4.2.9.3.1 Field OrganisationId
2.4.2.9.3.1.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.4.2.9.3.2 Field ParentOrganisationId
2.4.2.9.3.2.1 ParentOrganisationId properties
| Property | Value |
| Name | ParentOrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to parent organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.4.2.9.3.3 Field Name
2.4.2.9.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of organization |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BuildingMinds |
| Comments |
2.4.2.9.3.4 Field Industry
2.4.2.9.3.4.1 Industry properties
| Property | Value |
| Name | Industry |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Industry of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Service Provider |
| Comments |
2.4.2.9.3.5 Field Email
2.4.2.9.3.5.1 Email properties
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Email of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 100 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | test@google.com |
| Comments |
2.4.2.9.3.6 Field Telephone
2.4.2.9.3.6.1 Telephone properties
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 112 |
| Comments |
2.4.2.9.3.7 Field Fax
2.4.2.9.3.7.1 Fax properties
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of organisation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 3 |
| Max length | 35 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 22228888 |
| Comments |
2.4.2.9.3.8 Field VatNumber
2.4.2.9.3.8.1 VatNumber properties
| Property | Value |
| Name | VatNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Vat number of organisation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 5 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE123456789 |
| Comments |
2.4.2.9.3.9 Field LegalEntity
2.4.2.9.3.9.1 LegalEntity properties
| Property | Value |
| Name | LegalEntity |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the organisation an legal entity (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.4.2.9.3.10 Field FiscalYearStartDate
2.4.2.9.3.10.1 FiscalYearStartDate properties
| Property | Value |
| Name | FiscalYearStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-03-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.9.4 Organisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Organisation",
"properties": {
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParentOrganisationId": {
"type": "string",
"description": "Link to parent organisation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of organization",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Industry": {
"type": "string",
"description": "Industry of organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"description": "Email of organisation",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of organisation",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Fax": {
"type": "string",
"description": "Fax number of organisation",
"minLength": 3,
"maxLength": 35,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"VatNumber": {
"type": "string",
"description": "Vat number of organisation",
"minLength": 5,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LegalEntity": {
"type": "boolean",
"description": "Is the organisation an legal entity (Y/N)"
},
"FiscalYearStartDate": {
"type": "string",
"description": "Start date of fiscal year for organisation in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
}
},
"required": [
"OrganisationId",
"Name",
"VatNumber",
"LegalEntity",
"FiscalYearStartDate"
]
}2.4.2.9.5 Organisation JSON data
{
"OrganisationId": "BM2016271",
"ParentOrganisationId": "BM2016271",
"Name": "BuildingMinds",
"Industry": "Service Provider",
"Email": "test@google.com",
"Telephone": "112",
"Fax": "22228888",
"VatNumber": "DE123456789",
"LegalEntity": true,
"FiscalYearStartDate": "2021-03-01 00:00:00"
}2.4.2.10 Document Role
2.4.2.10.1 Role Tree Diagram
2.4.2.10.2 Role Properties
| Property | Value |
| Document name | Role |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.10.3 Role Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of Role e.g. Owner |
2.4.2.10.3.1 Field RoleId
2.4.2.10.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.10.3.2 Field Type
2.4.2.10.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Role e.g. Owner |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.4.2.10.4 Role JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Role",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Role e.g. Owner",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"Type"
]
}2.4.2.10.5 Role JSON data
{
"RoleId": "R-01",
"Type": "Lorem"
}2.4.2.11 Document RoleBuilding
2.4.2.11.1 RoleBuilding Tree Diagram
2.4.2.11.2 RoleBuilding Properties
| Property | Value |
| Document name | RoleBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.11.3 RoleBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.11.3.1 Field RoleId
2.4.2.11.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.11.3.2 Field BuildingId
2.4.2.11.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to OrganisationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.4.2.11.4 RoleBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleBuilding",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"BuildingId"
]
}2.4.2.11.5 RoleBuilding JSON data
{
"RoleId": "R-01",
"BuildingId": "SE-CH-2341"
}2.4.2.12 Document RoleContact
2.4.2.12.1 RoleContact Tree Diagram
2.4.2.12.2 RoleContact Properties
| Property | Value |
| Document name | RoleContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.12.3 RoleContact Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ContactId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.12.3.1 Field RoleId
2.4.2.12.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.12.3.2 Field ContactId
2.4.2.12.3.2.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Contact |
| Foreign field | ContactId |
| Relationship type | |
| Relationship name | fk Contact. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BP-00441 |
| Comments |
2.4.2.12.4 RoleContact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleContact",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ContactId"
]
}2.4.2.12.5 RoleContact JSON data
{
"RoleId": "R-01",
"ContactId": "BP-00441"
}2.4.2.13 Document RoleLand
2.4.2.13.1 RoleLand Tree Diagram
2.4.2.13.2 RoleLand Properties
| Property | Value |
| Document name | RoleLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.13.3 RoleLand Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.4.2.13.3.1 Field RoleId
2.4.2.13.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.13.3.2 Field LandId
2.4.2.13.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to OrganisationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.4.2.13.4 RoleLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleLand",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"LandId"
]
}2.4.2.13.5 RoleLand JSON data
{
"RoleId": "R-01",
"LandId": "RE-AT-05"
}2.4.2.14 Document RoleOrganisation
2.4.2.14.1 RoleOrganisation Tree Diagram
2.4.2.14.2 RoleOrganisation Properties
| Property | Value |
| Document name | RoleOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.14.3 RoleOrganisation Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| OrganisationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.14.3.1 Field RoleId
2.4.2.14.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RoleContact. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.14.3.2 Field OrganisationId
2.4.2.14.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | |
| Relationship name | fk Organisation. to RoleOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | BM2016271 |
| Comments |
2.4.2.14.4 RoleOrganisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleOrganisation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"OrganisationId"
]
}2.4.2.14.5 RoleOrganisation JSON data
{
"RoleId": "R-01",
"OrganisationId": "BM2016271"
}2.4.2.15 Document RolePortfolio
2.4.2.15.1 RolePortfolio Tree Diagram
2.4.2.15.2 RolePortfolio Properties
| Property | Value |
| Document name | RolePortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.15.3 RolePortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.4.2.15.3.1 Field RoleId
2.4.2.15.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.15.3.2 Field PortfolioId
2.4.2.15.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | |
| Relationship name | fk Portfolio. to OrganisationPortfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.4.2.15.4 RolePortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolio",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioId"
]
}2.4.2.15.5 RolePortfolio JSON data
{
"RoleId": "R-01",
"PortfolioId": "PF-03-01"
}2.4.2.16 Document RolePortfolioStrategy
2.4.2.16.1 RolePortfolioStrategy Tree Diagram
2.4.2.16.2 RolePortfolioStrategy Properties
| Property | Value |
| Document name | RolePortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.16.3 RolePortfolioStrategy Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioStrategyId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.4.2.16.3.1 Field RoleId
2.4.2.16.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationPortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.16.3.2 Field PortfolioStrategyId
2.4.2.16.3.2.1 PortfolioStrategyId properties
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | fk Portfolio. to RolePortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | x01 |
| Comments |
2.4.2.16.4 RolePortfolioStrategy JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolioStrategy",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioStrategyId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioStrategyId"
]
}2.4.2.16.5 RolePortfolioStrategy JSON data
{
"RoleId": "R-01",
"PortfolioStrategyId": "x01"
}2.4.2.17 Document RoleRentalUnit
2.4.2.17.1 RoleRentalUnit Tree Diagram
2.4.2.17.2 RoleRentalUnit Properties
| Property | Value |
| Document name | RoleRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.17.3 RoleRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.17.3.1 Field RoleId
2.4.2.17.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.17.3.2 Field RentalUnitId
2.4.2.17.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | fk RentalUnit. to OrganisationRentalUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.4.2.17.4 RoleRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleRentalUnit",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"RentalUnitId"
]
}2.4.2.17.5 RoleRentalUnit JSON data
{
"RoleId": "R-01",
"RentalUnitId": "B-RU-10293"
}2.4.2.18 Document RoleSite
2.4.2.18.1 RoleSite Tree Diagram
2.4.2.18.2 RoleSite Properties
| Property | Value |
| Document name | RoleSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.18.3 RoleSite Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.18.3.1 Field RoleId
2.4.2.18.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.18.3.2 Field SiteId
2.4.2.18.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to OrganisationSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.4.2.18.4 RoleSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleSite",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"SiteId"
]
}2.4.2.18.5 RoleSite JSON data
{
"RoleId": "R-01",
"SiteId": "AE-DE-02"
}2.4.2.19 Document RoleValuation
2.4.2.19.1 RoleValuation Tree Diagram
2.4.2.19.2 RoleValuation Properties
| Property | Value |
| Document name | RoleValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | OrganisationalManagement |
| Additional properties | |
| Comments |
2.4.2.19.3 RoleValuation Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) |
2.4.2.19.3.1 Field RoleId
2.4.2.19.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to OrganisationValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.4.2.19.3.2 Field ValuationId
2.4.2.19.3.2.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to OrganisationValuation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.4.2.19.4 RoleValuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleValuation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ValuationId"
]
}2.4.2.19.5 RoleValuation JSON data
{
"RoleId": "R-01",
"ValuationId": "V021"
}2.5 Group PortfolioAndAssetManagement
2.5.1 PortfolioAndAssetManagement Properties
| Property | Value |
| Group name | PortfolioAndAssetManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.5.2 PortfolioAndAssetManagement Documents
2.5.2.1 Document Portfolio
2.5.2.1.1 Portfolio Tree Diagram
2.5.2.1.2 Portfolio Properties
| Property | Value |
| Document name | Portfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | false |
| Comments |
2.5.2.1.3 Portfolio Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| Name | string | true | Name of Portfolio | ||
| PortfolioCode | string | false | User specific Portfolio Code e.g: MR003 | ||
| Type | string | true | Type of the Portfolio | ||
| AssetCategory | string | false | Describes the asset category | ||
| OwnershipType | string | false | Describes the ownership structure of the portfolio | ||
| ValidFrom | date-time | true | Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PrimaryUsageType | string | false | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| SecondaryUsageType | string | false | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| MarketValue | number | false | Current market value of Portfolio | [{"dataType":"float"}] | |
| Currency | string | false | Main/default currency of portfolio (depending on user it should be able to change this) | ||
| IndividualAccountId | string | true | fk | Link to individual account |
2.5.2.1.3.1 Field PortfolioId
2.5.2.1.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.1.3.2 Field Name
2.5.2.1.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Portfolio |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | South Germany |
| Comments |
2.5.2.1.3.3 Field PortfolioCode
2.5.2.1.3.3.1 PortfolioCode properties
| Property | Value |
| Name | PortfolioCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Portfolio Code e.g: MR003 |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | |
| Max length | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | GS-012 |
| Comments |
2.5.2.1.3.4 Field Type
2.5.2.1.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the Portfolio |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.1.3.5 Field AssetCategory
2.5.2.1.3.5.1 AssetCategory properties
| Property | Value |
| Name | AssetCategory |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the asset category |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Tangible |
| Comments |
2.5.2.1.3.6 Field OwnershipType
2.5.2.1.3.6.1 OwnershipType properties
| Property | Value |
| Name | OwnershipType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the ownership structure of the portfolio |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Freehold |
| Comments |
2.5.2.1.3.7 Field ValidFrom
2.5.2.1.3.7.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.1.3.8 Field ValidUntil
2.5.2.1.3.8.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.1.3.9 Field PrimaryUsageType
2.5.2.1.3.9.1 PrimaryUsageType properties
| Property | Value |
| Name | PrimaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Financial Assets |
| Comments |
2.5.2.1.3.10 Field SecondaryUsageType
2.5.2.1.3.10.1 SecondaryUsageType properties
| Property | Value |
| Name | SecondaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Freehold |
| Comments |
2.5.2.1.3.11 Field MarketValue
2.5.2.1.3.11.1 MarketValue properties
| Property | Value |
| Name | MarketValue |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Current market value of Portfolio |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2617281.27 |
| Comments | [{"dataType":"float"}] |
2.5.2.1.3.12 Field Currency
2.5.2.1.3.12.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main/default currency of portfolio (depending on user it should be able to change this) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.5.2.1.3.13 Field IndividualAccountId
2.5.2.1.3.13.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to individual account |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to Portfolio. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.5.2.1.4 Portfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Portfolio",
"additionalProperties": false,
"properties": {
"PortfolioId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Portfolio ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"PortfolioCode": {
"type": "string",
"description": "User specific Portfolio Code e.g: MR003",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of the Portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 75
},
"AssetCategory": {
"type": "string",
"description": "Describes the asset category",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OwnershipType": {
"type": "string",
"description": "Describes the ownership structure of the portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 25
},
"ValidFrom": {
"type": "string",
"description": "Date portfolio was set up in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date the maturity of the portfolio has been reached in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"PrimaryUsageType": {
"type": "string",
"description": "Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryUsageType": {
"type": "string",
"description": "Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"MarketValue": {
"type": "number",
"description": "Current market value of Portfolio",
"minimum": -999999999999,
"maximum": 999999999999
},
"Currency": {
"type": "string",
"description": "Main/default currency of portfolio (depending on user it should be able to change this)",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Link to individual account",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"Name",
"Type",
"ValidFrom",
"ValidUntil",
"IndividualAccountId"
]
}2.5.2.1.5 Portfolio JSON data
{
"PortfolioId": "PF-03-01",
"Name": "South Germany",
"PortfolioCode": "GS-012",
"Type": "Lorem",
"AssetCategory": "Tangible",
"OwnershipType": "Freehold",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 00:00:00",
"PrimaryUsageType": "Financial Assets",
"SecondaryUsageType": "Freehold",
"MarketValue": 2617281.27,
"Currency": "Euro",
"IndividualAccountId": "1890627182"
}2.5.2.2 Document PortfolioBuilding
2.5.2.2.1 PortfolioBuilding Tree Diagram
2.5.2.2.2 PortfolioBuilding Properties
| Property | Value |
| Document name | PortfolioBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.2.3 PortfolioBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.2.3.1 Field PortfolioId
2.5.2.2.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(41) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.2.3.2 Field BuildingId
2.5.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to PortfolioBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.5.2.2.4 PortfolioBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioBuilding",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"BuildingId"
]
}2.5.2.2.5 PortfolioBuilding JSON data
{
"PortfolioId": "PF-03-01",
"BuildingId": "SE-CH-2341"
}2.5.2.3 Document PortfolioLand
2.5.2.3.1 PortfolioLand Tree Diagram
2.5.2.3.2 PortfolioLand Properties
| Property | Value |
| Document name | PortfolioLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.3.3 PortfolioLand Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.3.3.1 Field PortfolioId
2.5.2.3.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(42) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.3.3.2 Field LandId
2.5.2.3.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to PortfolioLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.5.2.3.4 PortfolioLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioLand",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"LandId"
]
}2.5.2.3.5 PortfolioLand JSON data
{
"PortfolioId": "PF-03-01",
"LandId": "AE-DE-02"
}2.5.2.4 Document PortfolioSite
2.5.2.4.1 PortfolioSite Tree Diagram
2.5.2.4.2 PortfolioSite Properties
| Property | Value |
| Document name | PortfolioSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.4.3 PortfolioSite Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SiteId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.4.3.1 Field PortfolioId
2.5.2.4.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | New Relationship(30) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.4.3.2 Field SiteId
2.5.2.4.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | |
| Relationship name | fk Site. to PortfolioSite. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AE-DE-02 |
| Comments |
2.5.2.4.4 PortfolioSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioSite",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"SiteId"
]
}2.5.2.4.5 PortfolioSite JSON data
{
"PortfolioId": "PF-03-01",
"SiteId": "AE-DE-02"
}2.5.2.5 Document PortfolioStrategy
2.5.2.5.1 PortfolioStrategy Tree Diagram
2.5.2.5.2 PortfolioStrategy Properties
| Property | Value |
| Document name | PortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.5.3 PortfolioStrategy Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioStrategyId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| Name | string | true | Name of Strategy (user specific) | ||
| InvestmentType | string | false | Type of Strategy | ||
| ValidFrom | date-time | true | Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StrategyObjectiveTargetsSteering | string | true | Steering target type of Portfolio Strategy | ||
| StrategyObjectiveValuesSteering | number | true | Value of the portfolio strategy steering targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnitSteering | string | true | Unit of strategy objective values steering | [{"dataType":"float"}] | |
| StrategyObjectiveTargets | string | false | Target type of Portfolio Strategy | ||
| StrategyObjectiveValues | number | false | Value of the portfolio strategy targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnit | string | false | Unit of strategy objective values | ||
| Source | string | false | Source of Portfolio strategy | ||
| PortfolioId | string | true | fk | Link to Portfolio |
2.5.2.5.3.1 Field PortfolioStrategyId
2.5.2.5.3.1.1 PortfolioStrategyId properties
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | x01 |
| Comments |
2.5.2.5.3.2 Field Name
2.5.2.5.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Strategy (user specific) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Core longterm value add |
| Comments |
2.5.2.5.3.3 Field InvestmentType
2.5.2.5.3.3.1 InvestmentType properties
| Property | Value |
| Name | InvestmentType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Value add |
| Comments |
2.5.2.5.3.4 Field ValidFrom
2.5.2.5.3.4.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.5.3.5 Field ValidUntil
2.5.2.5.3.5.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.5.3.6 Field StrategyObjectiveTargetsSteering
2.5.2.5.3.6.1 StrategyObjectiveTargetsSteering properties
| Property | Value |
| Name | StrategyObjectiveTargetsSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Steering target type of Portfolio Strategy |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equity target |
| Comments |
2.5.2.5.3.7 Field StrategyObjectiveValuesSteering
2.5.2.5.3.7.1 StrategyObjectiveValuesSteering properties
| Property | Value |
| Name | StrategyObjectiveValuesSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of the portfolio strategy steering targets |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 6378123.45 |
| Comments | [{"dataType":"float"}] |
2.5.2.5.3.8 Field StrategyObjectiveUnitSteering
2.5.2.5.3.8.1 StrategyObjectiveUnitSteering properties
| Property | Value |
| Name | StrategyObjectiveUnitSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values steering |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments | [{"dataType":"float"}] |
2.5.2.5.3.9 Field StrategyObjectiveTargets
2.5.2.5.3.9.1 StrategyObjectiveTargets properties
| Property | Value |
| Name | StrategyObjectiveTargets |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Target type of Portfolio Strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Equity target |
| Comments |
2.5.2.5.3.10 Field StrategyObjectiveValues
2.5.2.5.3.10.1 StrategyObjectiveValues properties
| Property | Value |
| Name | StrategyObjectiveValues |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of the portfolio strategy targets |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 8000000 |
| Comments | [{"dataType":"float"}] |
2.5.2.5.3.11 Field StrategyObjectiveUnit
2.5.2.5.3.11.1 StrategyObjectiveUnit properties
| Property | Value |
| Name | StrategyObjectiveUnit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.5.2.5.3.12 Field Source
2.5.2.5.3.12.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of Portfolio strategy |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Europe branch |
| Comments |
2.5.2.5.3.13 Field PortfolioId
2.5.2.5.3.13.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to Portfolio |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | Portfolio |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioStrategy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.5.4 PortfolioStrategy JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioStrategy",
"properties": {
"PortfolioStrategyId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Strategy (user specific)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"InvestmentType": {
"type": "string",
"description": "Type of Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date Strategy was implemented in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date strategy has to be adapted by in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"StrategyObjectiveTargetsSteering": {
"type": "string",
"description": "Steering target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValuesSteering": {
"type": "number",
"description": "Value of the portfolio strategy steering targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnitSteering": {
"type": "string",
"description": "Unit of strategy objective values steering",
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 20
},
"StrategyObjectiveTargets": {
"type": "string",
"description": "Target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValues": {
"type": "number",
"description": "Value of the portfolio strategy targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnit": {
"type": "string",
"description": "Unit of strategy objective values",
"minLength": 1,
"maxLength": 20,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Source": {
"type": "string",
"description": "Source of Portfolio strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Link to Portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"PortfolioStrategyId",
"Name",
"ValidFrom",
"ValidUntil",
"StrategyObjectiveTargetsSteering",
"StrategyObjectiveValuesSteering",
"StrategyObjectiveUnitSteering",
"PortfolioId"
]
}2.5.2.5.5 PortfolioStrategy JSON data
{
"PortfolioStrategyId": "x01",
"Name": "Core longterm value add",
"InvestmentType": "Value add",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 00:00:00",
"StrategyObjectiveTargetsSteering": "Equity target",
"StrategyObjectiveValuesSteering": 6378123.45,
"StrategyObjectiveUnitSteering": "Euro",
"StrategyObjectiveTargets": "Equity target",
"StrategyObjectiveValues": 8000000,
"StrategyObjectiveUnit": "Euro",
"Source": "Europe branch",
"PortfolioId": "PF-03-01"
}2.5.2.6 Document PortfolioUnit
2.5.2.6.1 PortfolioUnit Tree Diagram
2.5.2.6.2 PortfolioUnit Properties
| Property | Value |
| Document name | PortfolioUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.6.3 PortfolioUnit Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.6.3.1 Field PortfolioId
2.5.2.6.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | |
| Relationship name | fk Portfolio. to PortfolioUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | PF-03-01 |
| Comments |
2.5.2.6.3.2 Field UnitId
2.5.2.6.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to PortfolioUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.5.2.6.4 PortfolioUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioUnit",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"UnitId"
]
}2.5.2.6.5 PortfolioUnit JSON data
{
"PortfolioId": "PF-03-01",
"UnitId": "UN-SE-CH-2341-02"
}2.5.2.7 Document Valuation
2.5.2.7.1 Valuation Tree Diagram
2.5.2.7.2 Valuation Properties
| Property | Value |
| Document name | Valuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.7.3 Valuation Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PreviousValuationId | string | false | Link to previous valuation | ||
| Name | string | true | Name of valuation | ||
| Type | string | true | Type of valuation | ||
| ValidFrom | date-time | true | Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Description | string | false | Description of valuation implementation | ||
| Text | string | false | Text field | ||
| Keywords | string | false | Important keywords | ||
| URL | string | false | URL if existent | ||
| JurisdictionType | string | false | Type of Jurisdiction | ||
| ProfessionalStandard | string | false | Name of professional valuation standard used | ||
| AccountingStandard | string | false | Name of Accounting standard used | ||
| JurisdictionStandard | string | false | Name of Jurisdiction type used | ||
| Value | number | true | Value of Valuation | [{"dataType":"float"}] | |
| Unit | string | true | Unit of valuation | ||
| Assumptions | string | false | Concluded assumptions | ||
| SpecialAssumptions | string | false | Concluded special assumptions | ||
| Constrains | string | false | Existing constrains | ||
| Approach | string | false | Valuation approach | ||
| MaintenanceBacklog | boolean | false | Does a maintenance backlog exist (Y/N) | ||
| SingleTenant | boolean | false | Valuation of single tenant building (Y/N) | ||
| DiscountRate | number | false | Discount rate included | [{"dataType":"float"}] | |
| DiscountPremiums | number | false | Discount premiums included | [{"dataType":"float"}] | |
| Uncertainty | string | false | LoV for uncertainty | ||
| Liquidity | number | false | Amount of cash | [{"dataType":"float"}] | |
| SpaceEfficiency | string | false | Space usage efficiency | ||
| EnergyEfficiency | string | false | Stating the energy efficiency class | ||
| DocumentId | string | false | Link to document | does not exist yet |
2.5.2.7.3.1 Field ValuationId
2.5.2.7.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.5.2.7.3.2 Field PreviousValuationId
2.5.2.7.3.2.1 PreviousValuationId properties
| Property | Value |
| Name | PreviousValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to previous valuation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V020 |
| Comments |
2.5.2.7.3.3 Field Name
2.5.2.7.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of valuation |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Comparative Valuation |
| Comments |
2.5.2.7.3.4 Field Type
2.5.2.7.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 75 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Comparative method |
| Comments |
2.5.2.7.3.5 Field ValidFrom
2.5.2.7.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-09-14 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.7.3.6 Field ValidUntil
2.5.2.7.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2050-09-21 12:23:56 |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.7.3.7 Field Description
2.5.2.7.3.7.1 Description properties
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of valuation implementation |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.8 Field Text
2.5.2.7.3.8.1 Text properties
| Property | Value |
| Name | Text |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Text field |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.9 Field Keywords
2.5.2.7.3.9.1 Keywords properties
| Property | Value |
| Name | Keywords |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Important keywords |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.10 Field URL
2.5.2.7.3.10.1 URL properties
| Property | Value |
| Name | URL |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | URL if existent |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.11 Field JurisdictionType
2.5.2.7.3.11.1 JurisdictionType properties
| Property | Value |
| Name | JurisdictionType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Jurisdiction |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RICS valuation |
| Comments |
2.5.2.7.3.12 Field ProfessionalStandard
2.5.2.7.3.12.1 ProfessionalStandard properties
| Property | Value |
| Name | ProfessionalStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of professional valuation standard used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.13 Field AccountingStandard
2.5.2.7.3.13.1 AccountingStandard properties
| Property | Value |
| Name | AccountingStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Accounting standard used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | IFRS |
| Comments |
2.5.2.7.3.14 Field JurisdictionStandard
2.5.2.7.3.14.1 JurisdictionStandard properties
| Property | Value |
| Name | JurisdictionStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Jurisdiction type used |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Local legislation |
| Comments |
2.5.2.7.3.15 Field Value
2.5.2.7.3.15.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of Valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 6378123.45 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.16 Field Unit
2.5.2.7.3.16.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of valuation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 20 |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.5.2.7.3.17 Field Assumptions
2.5.2.7.3.17.1 Assumptions properties
| Property | Value |
| Name | Assumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded assumptions |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.18 Field SpecialAssumptions
2.5.2.7.3.18.1 SpecialAssumptions properties
| Property | Value |
| Name | SpecialAssumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded special assumptions |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.19 Field Constrains
2.5.2.7.3.19.1 Constrains properties
| Property | Value |
| Name | Constrains |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Existing constrains |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.20 Field Approach
2.5.2.7.3.20.1 Approach properties
| Property | Value |
| Name | Approach |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Valuation approach |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.21 Field MaintenanceBacklog
2.5.2.7.3.21.1 MaintenanceBacklog properties
| Property | Value |
| Name | MaintenanceBacklog |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does a maintenance backlog exist (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.5.2.7.3.22 Field SingleTenant
2.5.2.7.3.22.1 SingleTenant properties
| Property | Value |
| Name | SingleTenant |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Valuation of single tenant building (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.5.2.7.3.23 Field DiscountRate
2.5.2.7.3.23.1 DiscountRate properties
| Property | Value |
| Name | DiscountRate |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount rate included |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percentage |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 7.29 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.24 Field DiscountPremiums
2.5.2.7.3.24.1 DiscountPremiums properties
| Property | Value |
| Name | DiscountPremiums |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount premiums included |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percentage |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2.87 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.25 Field Uncertainty
2.5.2.7.3.25.1 Uncertainty properties
| Property | Value |
| Name | Uncertainty |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | LoV for uncertainty |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.26 Field Liquidity
2.5.2.7.3.26.1 Liquidity properties
| Property | Value |
| Name | Liquidity |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Amount of cash |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 4539.27 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.27 Field SpaceEfficiency
2.5.2.7.3.27.1 SpaceEfficiency properties
| Property | Value |
| Name | SpaceEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Space usage efficiency |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.5.2.7.3.28 Field EnergyEfficiency
2.5.2.7.3.28.1 EnergyEfficiency properties
| Property | Value |
| Name | EnergyEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Stating the energy efficiency class |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | A |
| Comments |
2.5.2.7.3.29 Field DocumentId
2.5.2.7.3.29.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
2.5.2.7.4 Valuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Valuation",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PreviousValuationId": {
"type": "string",
"description": "Link to previous valuation",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of valuation ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"Type": {
"type": "string",
"description": "Type of valuation",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date valuation is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"format": "date-time",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19
},
"ValidUntil": {
"type": "string",
"description": "Date valuation has to be redone in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"default": "2199-12-31 00:00:00",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"Description": {
"type": "string",
"description": "Description of valuation implementation",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Text": {
"type": "string",
"description": "Text field",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Keywords": {
"type": "string",
"description": "Important keywords",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"URL": {
"type": "string",
"description": "URL if existent",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionType": {
"type": "string",
"description": "Type of Jurisdiction",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ProfessionalStandard": {
"type": "string",
"description": "Name of professional valuation standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountingStandard": {
"type": "string",
"description": "Name of Accounting standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionStandard": {
"type": "string",
"description": "Name of Jurisdiction type used",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Value": {
"type": "number",
"description": "Value of Valuation",
"minimum": -999999999999,
"maximum": 999999999999
},
"Unit": {
"type": "string",
"description": "Unit of valuation",
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 20
},
"Assumptions": {
"type": "string",
"description": "Concluded assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpecialAssumptions": {
"type": "string",
"description": "Concluded special assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Constrains": {
"type": "string",
"description": "Existing constrains",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Approach": {
"type": "string",
"description": "Valuation approach",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MaintenanceBacklog": {
"type": "boolean",
"description": "Does a maintenance backlog exist (Y/N)"
},
"SingleTenant": {
"type": "boolean",
"description": "Valuation of single tenant building (Y/N)"
},
"DiscountRate": {
"type": "number",
"description": "Discount rate included",
"minimum": 0,
"maximum": 100
},
"DiscountPremiums": {
"type": "number",
"description": "Discount premiums included",
"minimum": 0,
"maximum": 100
},
"Uncertainty": {
"type": "string",
"description": "LoV for uncertainty",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Liquidity": {
"type": "number",
"description": "Amount of cash"
},
"SpaceEfficiency": {
"type": "string",
"description": "Space usage efficiency",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiency": {
"type": "string",
"description": "Stating the energy efficiency class",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
" DocumentId": {
"type": "string",
"description": "Link to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"Name",
"Type",
"ValidFrom",
"ValidUntil",
"Value",
"Unit"
]
}2.5.2.7.5 Valuation JSON data
{
"ValuationId": "V021",
"PreviousValuationId": "V020",
"Name": "Comparative Valuation",
"Type": "Comparative method",
"ValidFrom": "2021-09-14 00:00:00",
"ValidUntil": "2050-09-21 12:23:56",
"Description": "Lorem",
"Text": "Lorem",
"Keywords": "Lorem",
"URL": "Lorem",
"JurisdictionType": "RICS valuation",
"ProfessionalStandard": "Lorem",
"AccountingStandard": "IFRS",
"JurisdictionStandard": "Local legislation",
"Value": 6378123.45,
"Unit": "Euro",
"Assumptions": "Lorem",
"SpecialAssumptions": "Lorem",
"Constrains": "Lorem",
"Approach": "Lorem",
"MaintenanceBacklog": true,
"SingleTenant": true,
"DiscountRate": 7.29,
"DiscountPremiums": 2.87,
"Uncertainty": "Lorem",
"Liquidity": 4539.27,
"SpaceEfficiency": "Lorem",
"EnergyEfficiency": "A",
" DocumentId": "Lorem"
}2.5.2.8 Document ValuationAccount
2.5.2.8.1 ValuationAccount Tree Diagram
2.5.2.8.2 ValuationAccount Properties
| Property | Value |
| Document name | ValuationAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.8.3 ValuationAccount Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| IndividualAccountId | string | true | Individual Account number |
2.5.2.8.3.1 Field ValuationId
2.5.2.8.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.5.2.8.3.2 Field IndividualAccountId
2.5.2.8.3.2.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | |
| Relationship name | fk IndividualAccount. to ValuationAccount. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1890627182 |
| Comments |
2.5.2.8.4 ValuationAccount JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationAccount",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Individual Account number",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"IndividualAccountId"
]
}2.5.2.8.5 ValuationAccount JSON data
{
"ValuationId": "V021",
"IndividualAccountId": "1890627182"
}2.5.2.9 Document ValuationBuilding
2.5.2.9.1 ValuationBuilding Tree Diagram
2.5.2.9.2 ValuationBuilding Properties
| Property | Value |
| Document name | ValuationBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.9.3 ValuationBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.9.3.1 Field ValuationId
2.5.2.9.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.5.2.9.3.2 Field BuildingId
2.5.2.9.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to ValuationBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.5.2.9.4 ValuationBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationBuilding",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"BuildingId"
]
}2.5.2.9.5 ValuationBuilding JSON data
{
"ValuationId": "V021",
"BuildingId": "SE-CH-2341"
}2.5.2.10 Document ValuationLand
2.5.2.10.1 ValuationLand Tree Diagram
2.5.2.10.2 ValuationLand Properties
| Property | Value |
| Document name | ValuationLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.10.3 ValuationLand Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| LandId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.5.2.10.3.1 Field ValuationId
2.5.2.10.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.5.2.10.3.2 Field LandId
2.5.2.10.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to ValuationLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.5.2.10.4 ValuationLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationLand",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"LandId"
]
}2.5.2.10.5 ValuationLand JSON data
{
"ValuationId": "V021",
"LandId": "RE-AT-05"
}2.5.2.11 Document ValuationOperationalMeasurement
2.5.2.11.1 ValuationOperationalMeasurement Tree Diagram
2.5.2.11.2 ValuationOperationalMeasurement Properties
| Property | Value |
| Document name | ValuationOperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PortfolioAndAssetManagement |
| Additional properties | |
| Comments |
2.5.2.11.3 ValuationOperationalMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | Customer ID from previous system (ID before onboarding data to CDM) | ||
| OperationalMeasurementGuid | string | true | Globally Unique Identifier number |
2.5.2.11.3.1 Field ValuationId
2.5.2.11.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to CDM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | |
| Relationship name | fk Valuation. to ValuationAreaMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | V021 |
| Comments |
2.5.2.11.3.2 Field OperationalMeasurementGuid
2.5.2.11.3.2.1 OperationalMeasurementGuid properties
| Property | Value |
| Name | OperationalMeasurementGuid |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementGuid |
| Relationship type | |
| Relationship name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Cardinality | 0..n |
| Default | |
| Min length | 36 |
| Max length | 36 |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Format | |
| Enum | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments |
2.5.2.11.4 ValuationOperationalMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationOperationalMeasurement",
"properties": {
"ValuationId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to CDM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OperationalMeasurementGuid": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"ValuationId",
"OperationalMeasurementGuid"
]
}2.5.2.11.5 ValuationOperationalMeasurement JSON data
{
"ValuationId": "V021",
"OperationalMeasurementGuid": "271ef573-3521-474a-a3de-08c32b8156d6"
}2.6 Group PropertyManagement
2.6.1 PropertyManagement Properties
| Property | Value |
| Group name | PropertyManagement |
| Technical name | |
| Activated | true |
| Description | |
| Comments |
2.6.2 PropertyManagement Documents
2.6.2.1 Document Dunning
2.6.2.1.1 Dunning Tree Diagram
2.6.2.1.2 Dunning Properties
| Property | Value |
| Document name | Dunning |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.1.3 Dunning Fields
| Field | Type | Req | Key | Description | Comments |
| DunningId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| DunningLevel | string | true | Dunning level | ||
| DunningAmount | number | true | Dunning Amount | [{"dataType":"float"}] | |
| Currency | string | true | Currency of payment | ||
| PaymentAmount | number | true | Value of payment | [{"dataType":"float"}] | |
| InitialDueData | date-time | true | Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | ||
| PaymentDate | date-time | true | Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | ||
| RentalPaymentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.1.3.1 Field DunningId
2.6.2.1.3.1.1 DunningId properties
| Property | Value |
| Name | DunningId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | D-B-RU-10293 |
| Comments |
2.6.2.1.3.2 Field DunningLevel
2.6.2.1.3.2.1 DunningLevel properties
| Property | Value |
| Name | DunningLevel |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Dunning level |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 3 |
| Comments |
2.6.2.1.3.3 Field DunningAmount
2.6.2.1.3.3.1 DunningAmount properties
| Property | Value |
| Name | DunningAmount |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Dunning Amount |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 359.65 |
| Comments | [{"dataType":"float"}] |
2.6.2.1.3.4 Field Currency
2.6.2.1.3.4.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.6.2.1.3.5 Field PaymentAmount
2.6.2.1.3.5.1 PaymentAmount properties
| Property | Value |
| Name | PaymentAmount |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 130.22 |
| Comments | [{"dataType":"float"}] |
2.6.2.1.3.6 Field InitialDueData
2.6.2.1.3.6.1 InitialDueData properties
| Property | Value |
| Name | InitialDueData |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-06-31 11:49:37 |
| Comments |
2.6.2.1.3.7 Field PaymentDate
2.6.2.1.3.7.1 PaymentDate properties
| Property | Value |
| Name | PaymentDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2021-06-25 10:07:23 |
| Comments |
2.6.2.1.3.8 Field RentalPaymentId
2.6.2.1.3.8.1 RentalPaymentId properties
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalPayment |
| Foreign field | RentalPaymentId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalPayment. to Dunning. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RP-RC-6271 |
| Comments |
2.6.2.1.4 Dunning JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Dunning",
"properties": {
"DunningId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningLevel": {
"type": "string",
"description": "Dunning level",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningAmount": {
"type": "number",
"description": "Dunning Amount",
"minimum": 1,
"maximum": 999999
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PaymentAmount": {
"type": "number",
"description": "Value of payment",
"minimum": 1,
"maximum": 999999
},
"InitialDueData": {
"type": "string",
"description": "Initial due date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"PaymentDate": {
"type": "string",
"description": "Payment date in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"DunningId",
"DunningLevel",
"DunningAmount",
"Currency",
"PaymentAmount",
"InitialDueData",
"PaymentDate",
"RentalPaymentId"
]
}2.6.2.1.5 Dunning JSON data
{
"DunningId": "D-B-RU-10293",
"DunningLevel": "3",
"DunningAmount": 359.65,
"Currency": "Euro",
"PaymentAmount": 130.22,
"InitialDueData": "2021-06-31 11:49:37",
"PaymentDate": "2021-06-25 10:07:23",
"RentalPaymentId": "RP-RC-6271"
}2.6.2.2 Document RentalContract
2.6.2.2.1 RentalContract Tree Diagram
2.6.2.2.2 RentalContract Properties
| Property | Value |
| Document name | RentalContract |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | false |
| Comments |
2.6.2.2.3 RentalContract Fields
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| MainContractId | string | false | Main contract code | ||
| ContractCode | string | true | Contract Code (e.g. SAP) | ||
| ContractType | string | false | Contract type | ||
| CompanyCode | string | false | Company Code (e.g. SAP code) | ||
| ContractName | string | false | Contract name | ||
| ContractGroup | string | false | Contract group | ||
| RentBeginDate | date-time | true | Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| RentEndDate | date-time | true | Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PeriodOfNotice | string | false | Period of notice e.g. monthly; 3 month; 6 month etc. | ||
| PaymentInAdvance | boolean | true | Does the payment have to be conducted in advance (Y/N) | ||
| PaymentPeriod | string | true | Frequency of payment e.g. weekly, monthly, quarterly etc. | ||
| ShortTermLease | boolean | false | Is this a short term lease (Y/N) | ||
| TenantSector | string | false | Sector / Business area of the tenant | ||
| TurnoverReportingInterval | string | false | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
2.6.2.2.3.1 Field RentalContractId
2.6.2.2.3.1.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
2.6.2.2.3.2 Field MainContractId
2.6.2.2.3.2.1 MainContractId properties
| Property | Value |
| Name | MainContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main contract code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.6.2.2.3.3 Field ContractCode
2.6.2.2.3.3.1 ContractCode properties
| Property | Value |
| Name | ContractCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract Code (e.g. SAP) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1870_1867_00093 |
| Comments |
2.6.2.2.3.4 Field ContractType
2.6.2.2.3.4.1 ContractType properties
| Property | Value |
| Name | ContractType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract type |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Operating Lease |
| Comments |
2.6.2.2.3.5 Field CompanyCode
2.6.2.2.3.5.1 CompanyCode properties
| Property | Value |
| Name | CompanyCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Company Code (e.g. SAP code) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 1870 |
| Comments |
2.6.2.2.3.6 Field ContractName
2.6.2.2.3.6.1 ContractName properties
| Property | Value |
| Name | ContractName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract name |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Mainz Bürogebäude 6-0291 |
| Comments |
2.6.2.2.3.7 Field ContractGroup
2.6.2.2.3.7.1 ContractGroup properties
| Property | Value |
| Name | ContractGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract group |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Munich Main Office |
| Comments |
2.6.2.2.3.8 Field RentBeginDate
2.6.2.2.3.8.1 RentBeginDate properties
| Property | Value |
| Name | RentBeginDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2018-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.9 Field RentEndDate
2.6.2.2.3.9.1 RentEndDate properties
| Property | Value |
| Name | RentEndDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.10 Field ValidFrom
2.6.2.2.3.10.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 12:22:56 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.11 Field ValidUntil
2.6.2.2.3.11.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 23:21:12 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.12 Field PeriodOfNotice
2.6.2.2.3.12.1 PeriodOfNotice properties
| Property | Value |
| Name | PeriodOfNotice |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Period of notice e.g. monthly; 3 month; 6 month etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | 6 month |
| Comments |
2.6.2.2.3.13 Field PaymentInAdvance
2.6.2.2.3.13.1 PaymentInAdvance properties
| Property | Value |
| Name | PaymentInAdvance |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Does the payment have to be conducted in advance (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.6.2.2.3.14 Field PaymentPeriod
2.6.2.2.3.14.1 PaymentPeriod properties
| Property | Value |
| Name | PaymentPeriod |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Frequency of payment e.g. weekly, monthly, quarterly etc. |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | monthly |
| Comments |
2.6.2.2.3.15 Field ShortTermLease
2.6.2.2.3.15.1 ShortTermLease properties
| Property | Value |
| Name | ShortTermLease |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is this a short term lease (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | true |
| Sample | |
| Comments |
2.6.2.2.3.16 Field TenantSector
2.6.2.2.3.16.1 TenantSector properties
| Property | Value |
| Name | TenantSector |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sector / Business area of the tenant |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Research & development |
| Comments |
2.6.2.2.3.17 Field TurnoverReportingInterval
2.6.2.2.3.17.1 TurnoverReportingInterval properties
| Property | Value |
| Name | TurnoverReportingInterval |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | quarterly |
| Comments |
2.6.2.2.4 RentalContract JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContract",
"additionalProperties": false,
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MainContractId": {
"type": "string",
"description": "Main contract code",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractCode": {
"type": "string",
"description": "Contract Code (e.g. SAP)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 70
},
"ContractType": {
"type": "string",
"description": "Contract type",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CompanyCode": {
"type": "string",
"description": "Company Code (e.g. SAP code)",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractName": {
"type": "string",
"description": "Contract name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractGroup": {
"type": "string",
"description": "Contract group",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentBeginDate": {
"type": "string",
"description": "Date original contract starts in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"RentEndDate": {
"type": "string",
"description": "Date original contract ends in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"ValidFrom": {
"type": "string",
"description": "Date of first paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date of last paying month in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"PeriodOfNotice": {
"type": "string",
"description": "Period of notice e.g. monthly; 3 month; 6 month etc.",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"PaymentInAdvance": {
"type": "boolean",
"description": "Does the payment have to be conducted in advance (Y/N)"
},
"PaymentPeriod": {
"type": "string",
"description": "Frequency of payment e.g. weekly, monthly, quarterly etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ShortTermLease": {
"type": "boolean",
"description": "Is this a short term lease (Y/N)",
"default": true
},
"TenantSector": {
"type": "string",
"description": "Sector / Business area of the tenant",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TurnoverReportingInterval": {
"type": "string",
"description": "If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"ContractCode",
"RentBeginDate",
"RentEndDate",
"ValidFrom",
"ValidUntil",
"PaymentInAdvance",
"PaymentPeriod"
]
}2.6.2.2.5 RentalContract JSON data
{
"RentalContractId": "RC-6271",
"MainContractId": "R-01",
"ContractCode": "1870_1867_00093",
"ContractType": "Operating Lease",
"CompanyCode": "1870",
"ContractName": "Mainz Bürogebäude 6-0291",
"ContractGroup": "Munich Main Office",
"RentBeginDate": "2018-09-01 00:00:00",
"RentEndDate": "2020-09-01 00:00:00",
"ValidFrom": "2020-09-01 12:22:56",
"ValidUntil": "2025-12-31 23:21:12",
"PeriodOfNotice": "6 month",
"PaymentInAdvance": true,
"PaymentPeriod": "monthly",
"ShortTermLease": true,
"TenantSector": "Research & development",
"TurnoverReportingInterval": "quarterly"
}2.6.2.3 Document RentalContractRentalUnit
2.6.2.3.1 RentalContractRentalUnit Tree Diagram
2.6.2.3.2 RentalContractRentalUnit Properties
| Property | Value |
| Document name | RentalContractRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.3.3 RentalContractRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.3.3.1 Field RentalUnitId
2.6.2.3.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(43) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.3.3.2 Field RentalContractId
2.6.2.3.3.2.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | |
| Relationship name | New Relationship(43) |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
2.6.2.3.4 RentalContractRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRentalUnit",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"RentalContractId"
]
}2.6.2.3.5 RentalContractRentalUnit JSON data
{
"RentalUnitId": "B-RU-10293",
"RentalContractId": "RC-6271"
}2.6.2.4 Document RentalContractRole
2.6.2.4.1 RentalContractRole Tree Diagram
2.6.2.4.2 RentalContractRole Properties
| Property | Value |
| Document name | RentalContractRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.4.3 RentalContractRole Fields
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.4.3.1 Field RentalContractId
2.6.2.4.3.1.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | |
| Relationship name | fk RentalContract. to RentalContractOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
2.6.2.4.3.2 Field RoleId
2.6.2.4.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to RentalContractOrganisation. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.6.2.4.4 RentalContractRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRole",
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"RoleId"
]
}2.6.2.4.5 RentalContractRole JSON data
{
"RentalContractId": "RC-6271",
"RoleId": "R-01"
}2.6.2.5 Document RentalOption
2.6.2.5.1 RentalOption Tree Diagram
2.6.2.5.2 RentalOption Properties
| Property | Value |
| Document name | RentalOption |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.5.3 RentalOption Fields
| Field | Type | Req | Key | Description | Comments |
| RentalOptionId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of option | ||
| SubType | string | true | Subtype of the option | ||
| ValidFrom | date-time | true | Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| RentalContractId | string | true | fk | Reference to corresponding rental contract | |
| DocumentId | string | false | Reference to document | does not exist yet |
2.6.2.5.3.1 Field RentalOptionId
2.6.2.5.3.1.1 RentalOptionId properties
| Property | Value |
| Name | RentalOptionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | LO-RC-6271-1 |
| Comments |
2.6.2.5.3.2 Field Type
2.6.2.5.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of option |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Contract extension |
| Comments |
2.6.2.5.3.3 Field SubType
2.6.2.5.3.3.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of the option |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Renewal |
| Comments |
2.6.2.5.3.4 Field ValidFrom
2.6.2.5.3.4.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 04:29:59 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.5.3.5 Field ValidUntil
2.6.2.5.3.5.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.5.3.6 Field RentalContractId
2.6.2.5.3.6.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to corresponding rental contract |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalContract |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to LeaseOption. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
2.6.2.5.3.7 Field DocumentId
2.6.2.5.3.7.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to document |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
2.6.2.5.4 RentalOption JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalOption",
"properties": {
"RentalOptionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of option ",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SubType": {
"type": "string",
"description": "Subtype of the option",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date option is valid from in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date option is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"RentalContractId": {
"type": "string",
"description": "Reference to corresponding rental contract",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
" DocumentId": {
"type": "string",
"description": "Reference to document",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalOptionId",
"Type",
"SubType",
"ValidFrom",
"ValidUntil",
"RentalContractId"
]
}2.6.2.5.5 RentalOption JSON data
{
"RentalOptionId": "LO-RC-6271-1",
"Type": "Contract extension",
"SubType": "Renewal",
"ValidFrom": "2020-09-01 04:29:59",
"ValidUntil": "2025-12-31 00:00:00",
"RentalContractId": "RC-6271",
" DocumentId": "Lorem"
}2.6.2.6 Document RentalPayment
2.6.2.6.1 RentalPayment Tree Diagram
2.6.2.6.2 RentalPayment Properties
| Property | Value |
| Document name | RentalPayment |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.6.3 RentalPayment Fields
| Field | Type | Req | Key | Description | Comments |
| RentalPaymentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ValidFrom | date-time | true | Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Type | string | true | Type of lease payment | ||
| Currency | string | true | Currency of payment | ||
| ValueMonth | number | true | Value of payment per month | [{"dataType":"float"}] | |
| ValueYear | number | false | Value of payment per year | [{"dataType":"float"}] | |
| DiscountInPercentage | number | false | Discount percentage of payment | [{"dataType":"float"}] | |
| VatOpted | boolean | true | Is the vat payable (Y/N) | ||
| RentalContractId | string | true | fk | Reference to rental contract | |
| IndexId | string | false | Reference to index table | does not exist yet |
2.6.2.6.3.1 Field RentalPaymentId
2.6.2.6.3.1.1 RentalPaymentId properties
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RP-RC-6271 |
| Comments |
2.6.2.6.3.2 Field ValidFrom
2.6.2.6.3.2.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.6.3.3 Field ValidUntil
2.6.2.6.3.3.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.6.3.4 Field Type
2.6.2.6.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of lease payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Ancillary costs |
| Comments |
2.6.2.6.3.5 Field Currency
2.6.2.6.3.5.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Euro |
| Comments |
2.6.2.6.3.6 Field ValueMonth
2.6.2.6.3.6.1 ValueMonth properties
| Property | Value |
| Name | ValueMonth |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment per month |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 9999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 216.19 |
| Comments | [{"dataType":"float"}] |
2.6.2.6.3.7 Field ValueYear
2.6.2.6.3.7.1 ValueYear properties
| Property | Value |
| Name | ValueYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Value of payment per year |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | |
| Min value | 1 |
| Excl min | |
| Max value | 99999999 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 2594.28 |
| Comments | [{"dataType":"float"}] |
2.6.2.6.3.8 Field DiscountInPercentage
2.6.2.6.3.8.1 DiscountInPercentage properties
| Property | Value |
| Name | DiscountInPercentage |
| Technical name | |
| Activated | true |
| Id | |
| Type | number |
| Description | Discount percentage of payment |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Unit | Percent |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Enum | |
| Sample | 4.53 |
| Comments | [{"dataType":"float"}] |
2.6.2.6.3.9 Field VatOpted
2.6.2.6.3.9.1 VatOpted properties
| Property | Value |
| Name | VatOpted |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the vat payable (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.6.2.6.3.10 Field RentalContractId
2.6.2.6.3.10.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to rental contract |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | RentalContract |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalPaymentId. |
| Cardinality | 1..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RC-6271 |
| Comments |
2.6.2.6.3.11 Field IndexId
2.6.2.6.3.11.1 IndexId properties
| Property | Value |
| Name | IndexId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to index table |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments | does not exist yet |
2.6.2.6.4 RentalPayment JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalPayment",
"properties": {
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Starting date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "End date of payment in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"Type": {
"type": "string",
"description": "Type of lease payment",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValueMonth": {
"type": "number",
"description": "Value of payment per month",
"minimum": 1,
"maximum": 9999999
},
"ValueYear": {
"type": "number",
"description": "Value of payment per year",
"minimum": 1,
"maximum": 99999999
},
"DiscountInPercentage": {
"type": "number",
"description": "Discount percentage of payment",
"minimum": 0,
"maximum": 100
},
"VatOpted": {
"type": "boolean",
"description": "Is the vat payable (Y/N)"
},
"RentalContractId": {
"type": "string",
"description": "Reference to rental contract",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndexId": {
"type": "string",
"description": "Reference to index table",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalPaymentId",
"ValidFrom",
"ValidUntil",
"Type",
"Currency",
"ValueMonth",
"VatOpted",
"RentalContractId"
]
}2.6.2.6.5 RentalPayment JSON data
{
"RentalPaymentId": "RP-RC-6271",
"ValidFrom": "2020-09-01 00:00:00",
"ValidUntil": "2025-12-31 00:00:00",
"Type": "Ancillary costs",
"Currency": "Euro",
"ValueMonth": 216.19,
"ValueYear": 2594.28,
"DiscountInPercentage": 4.53,
"VatOpted": true,
"RentalContractId": "RC-6271",
"IndexId": "Lorem"
}2.6.2.7 Document RentalUnit
2.6.2.7.1 RentalUnit Tree Diagram
2.6.2.7.2 RentalUnit Properties
| Property | Value |
| Document name | RentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | false |
| Comments |
2.6.2.7.3 RentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of rental unit | ||
| RentalUnitCode | string | false | User specific RentalUnit Code | ||
| RentedOut | boolean | true | Is the RentalUnit rented out (Y/N) | ||
| UsageType | string | false | Usage type of the rental unit | ||
| Vacancy | boolean | false | Is the rental unit vacant (Y/N) |
2.6.2.7.3.1 Field Name
2.6.2.7.3.1.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of rental unit |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Heinrich-Heinestr. C602 |
| Comments |
2.6.2.7.3.2 Field RentalUnitCode
2.6.2.7.3.2.1 RentalUnitCode properties
| Property | Value |
| Name | RentalUnitCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific RentalUnit Code |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 70 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | DE-B-C602 |
| Comments |
2.6.2.7.3.3 Field RentedOut
2.6.2.7.3.3.1 RentedOut properties
| Property | Value |
| Name | RentedOut |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the RentalUnit rented out (Y/N) |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.6.2.7.3.4 Field RentalUnitId
2.6.2.7.3.4.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.7.3.5 Field UsageType
2.6.2.7.3.5.1 UsageType properties
| Property | Value |
| Name | UsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Usage type of the rental unit |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | Office |
| Comments |
2.6.2.7.3.6 Field Vacancy
2.6.2.7.3.6.1 Vacancy properties
| Property | Value |
| Name | Vacancy |
| Technical name | |
| Activated | true |
| Id | |
| Type | boolean |
| Description | Is the rental unit vacant (Y/N) |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Sample | true |
| Comments |
2.6.2.7.4 RentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnit",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "Name of rental unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitCode": {
"type": "string",
"description": "User specific RentalUnit Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentedOut": {
"type": "boolean",
"description": "Is the RentalUnit rented out (Y/N)"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UsageType": {
"type": "string",
"description": "Usage type of the rental unit",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vacancy": {
"type": "boolean",
"description": "Is the rental unit vacant (Y/N)"
}
},
"required": [
"Name",
"RentedOut",
"RentalUnitId"
]
}2.6.2.7.5 RentalUnit JSON data
{
"Name": "Heinrich-Heinestr. C602",
"RentalUnitCode": "DE-B-C602",
"RentedOut": true,
"RentalUnitId": "B-RU-10293",
"UsageType": "Office",
"Vacancy": true
}2.6.2.8 Document RentalUnitAreaMeasurement
2.6.2.8.1 RentalUnitAreaMeasurement Tree Diagram
2.6.2.8.2 RentalUnitAreaMeasurement Properties
| Property | Value |
| Document name | RentalUnitAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.8.3 RentalUnitAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| AreaMeasurementId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.6.2.8.3.1 Field RentalUnitId
2.6.2.8.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.8.3.2 Field AreaMeasurementId
2.6.2.8.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | |
| Relationship name | fk AreaMeasurement. to RentalUnitSpace copy. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | AM-CH-SE-2312 |
| Comments |
2.6.2.8.4 RentalUnitAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitAreaMeasurement",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"AreaMeasurementId"
]
}2.6.2.8.5 RentalUnitAreaMeasurement JSON data
{
"RentalUnitId": "B-RU-10293",
"AreaMeasurementId": "AM-CH-SE-2312"
}2.6.2.9 Document RentalUnitBuilding
2.6.2.9.1 RentalUnitBuilding Tree Diagram
2.6.2.9.2 RentalUnitBuilding Properties
| Property | Value |
| Document name | RentalUnitBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.9.3 RentalUnitBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| BuildingId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.9.3.1 Field RentalUnitId
2.6.2.9.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(44) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.9.3.2 Field BuildingId
2.6.2.9.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | |
| Relationship name | fk Building. to RentalUnitBuilding. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-2341 |
| Comments |
2.6.2.9.4 RentalUnitBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitBuilding",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"RentalUnitId",
"BuildingId"
]
}2.6.2.9.5 RentalUnitBuilding JSON data
{
"RentalUnitId": "B-RU-10293",
"BuildingId": "SE-CH-2341"
}2.6.2.10 Document RentalUnitFloor
2.6.2.10.1 RentalUnitFloor Tree Diagram
2.6.2.10.2 RentalUnitFloor Properties
| Property | Value |
| Document name | RentalUnitFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.10.3 RentalUnitFloor Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| FloorId | string | true | Customer ID from previous system (ID before onboarding data to BM) |
2.6.2.10.3.1 Field RentalUnitId
2.6.2.10.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.10.3.2 Field FloorId
2.6.2.10.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Customer ID from previous system (ID before onboarding data to BM) |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | |
| Relationship name | fk Floor. to RentalUnitFloor. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01 |
| Comments |
2.6.2.10.4 RentalUnitFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitFloor",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Customer ID from previous system (ID before onboarding data to BM)",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"FloorId"
]
}2.6.2.10.5 RentalUnitFloor JSON data
{
"RentalUnitId": "B-RU-10293",
"FloorId": "SE-CH-F-01"
}2.6.2.11 Document RentalUnitLand
2.6.2.11.1 RentalUnitLand Tree Diagram
2.6.2.11.2 RentalUnitLand Properties
| Property | Value |
| Document name | RentalUnitLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.11.3 RentalUnitLand Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| LandId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.11.3.1 Field RentalUnitId
2.6.2.11.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.11.3.2 Field LandId
2.6.2.11.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | |
| Relationship name | fk Land. to RentalUnitLand. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | RE-AT-05 |
| Comments |
2.6.2.11.4 RentalUnitLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitLand",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 40
}
},
"required": [
"RentalUnitId",
"LandId"
]
}2.6.2.11.5 RentalUnitLand JSON data
{
"RentalUnitId": "B-RU-10293",
"LandId": "RE-AT-05"
}2.6.2.12 Document RentalUnitSpace
2.6.2.12.1 RentalUnitSpace Tree Diagram
2.6.2.12.2 RentalUnitSpace Properties
| Property | Value |
| Document name | RentalUnitSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.12.3 RentalUnitSpace Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| SpaceId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.12.3.1 Field RentalUnitId
2.6.2.12.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.12.3.2 Field SpaceId
2.6.2.12.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | |
| Relationship name | fk Space. to RentalUnitSpace. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.6.2.12.4 RentalUnitSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitSpace",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"SpaceId"
]
}2.6.2.12.5 RentalUnitSpace JSON data
{
"RentalUnitId": "B-RU-10293",
"SpaceId": "SE-CH-F-01-21"
}2.6.2.13 Document RentalUnitUnit
2.6.2.13.1 RentalUnitUnit Tree Diagram
2.6.2.13.2 RentalUnitUnit Properties
| Property | Value |
| Document name | RentalUnitUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.13.3 RentalUnitUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| UnitId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.13.3.1 Field RentalUnitId
2.6.2.13.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | |
| Relationship name | New Relationship(45) |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.13.3.2 Field UnitId
2.6.2.13.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | |
| Relationship name | fk Unit. to RentalUnitUnit. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.6.2.13.4 RentalUnitUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitUnit",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"UnitId"
]
}2.6.2.13.5 RentalUnitUnit JSON data
{
"RentalUnitId": "B-RU-10293",
"UnitId": "UN-SE-CH-2341-02"
}2.6.2.14 Document TenantCommunication
2.6.2.14.1 TenantCommunication Tree Diagram
2.6.2.14.2 TenantCommunication Properties
| Property | Value |
| Document name | TenantCommunication |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.14.3 TenantCommunication Fields
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Type | string | true | Type of communication | ||
| Medium | string | false | Medium of communication | ||
| Description | string | true | Description of communciation | ||
| ValidFrom | date-time | true | Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Status | string | true | Status of communication | ||
| RentalUnitId | string | true | fk | Link to rental unit |
2.6.2.14.3.1 Field TenantCommunicationId
2.6.2.14.3.1.1 TenantCommunicationId properties
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | TC-20561 |
| Comments |
2.6.2.14.3.2 Field Type
2.6.2.14.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of communication |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.6.2.14.3.3 Field Medium
2.6.2.14.3.3.1 Medium properties
| Property | Value |
| Name | Medium |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Medium of communication |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 50 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.6.2.14.3.4 Field Description
2.6.2.14.3.4.1 Description properties
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of communciation |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 200 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.6.2.14.3.5 Field ValidFrom
2.6.2.14.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2020-09-01 00:00:00 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.14.3.6 Field ValidUntil
2.6.2.14.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061) |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | 2199-12-31 00:00:00 |
| Min length | 19 |
| Max length | 19 |
| Pattern | ^([0-9]{4})(-?)(1[0-2]|0[1-9])\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$ |
| Format | date-time |
| Enum | |
| Sample | 2025-12-31 11:59:14 |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.14.3.7 Field Status
2.6.2.14.3.7.1 Status properties
| Property | Value |
| Name | Status |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Status of communication |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Default | |
| Min length | 1 |
| Max length | 25 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.6.2.14.3.8 Field RentalUnitId
2.6.2.14.3.8.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to rental unit |
| Dependencies | |
| Required | true |
| Primary key | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to TenantCommunication. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.14.4 TenantCommunication JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunication",
"properties": {
"TenantCommunicationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Medium": {
"type": "string",
"description": "Medium of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Description": {
"type": "string",
"description": "Description of communciation",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"ValidFrom": {
"type": "string",
"description": "Date communication occurred in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"minLength": 19,
"maxLength": 19,
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date communication is valid until in yyyy-mm-dd hh:mm:ss form (conform to ISO 8061)",
"pattern": "^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9]) (2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
"minLength": 19,
"maxLength": 19,
"format": "date-time",
"default": "2199-12-31 00:00:00"
},
"Status": {
"type": "string",
"description": "Status of communication",
"minLength": 1,
"maxLength": 25,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Link to rental unit",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"Type",
"Description",
"ValidFrom",
"Status",
"RentalUnitId"
]
}2.6.2.14.5 TenantCommunication JSON data
{
"TenantCommunicationId": "TC-20561",
"Type": "Lorem",
"Medium": "Lorem",
"Description": "Lorem",
"ValidFrom": "2020-09-01 00:00:00",
"ValidUntil": "2025-12-31 11:59:14",
"Status": "Lorem",
"RentalUnitId": "B-RU-10293"
}2.6.2.15 Document TenantCommunicationRole
2.6.2.15.1 TenantCommunicationRole Tree Diagram
2.6.2.15.2 TenantCommunicationRole Properties
| Property | Value |
| Document name | TenantCommunicationRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | |
| Group | PropertyManagement |
| Additional properties | |
| Comments |
2.6.2.15.3 TenantCommunicationRole Fields
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | |||
| RoleId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.15.3.1 Field TenantCommunicationId
2.6.2.15.3.1.1 TenantCommunicationId properties
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | TenantCommunication |
| Foreign field | TenantCommunicationId |
| Relationship type | |
| Relationship name | fk TenantCommunication. to TenantCommunication. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | TC-20561 |
| Comments |
2.6.2.15.3.2 Field RoleId
2.6.2.15.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Dependencies | |
| Required | true |
| Primary key | true |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | |
| Relationship name | fk Role. to TenantCommunicationRole. |
| Cardinality | 0..n |
| Default | |
| Min length | 1 |
| Max length | 40 |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Format | |
| Enum | |
| Sample | R-01 |
| Comments |
2.6.2.15.4 TenantCommunicationRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunicationRole",
"properties": {
"TenantCommunicationId": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 40,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"RoleId"
]
}2.6.2.15.5 TenantCommunicationRole JSON data
{
"TenantCommunicationId": "TC-20561",
"RoleId": "R-01"
}3. Relationships
3.1 Relationship New Relationship
3.1.1 New Relationship Diagram
3.2 Relationship New Relationship(1)
3.2.1 New Relationship(1) Diagram
3.3 Relationship New Relationship(1)
3.3.1 New Relationship(1) Diagram
3.3.2 New Relationship(1) Properties
| Property | Value |
| Name | New Relationship(1) |
| Description | |
| Parent Document | Servitudes |
| Parent field | ServitudeId |
| Parent Cardinality | 1 |
| Child Document | Land |
| Child field | ServitudeId |
| Child Cardinality | 0..1 |
| Comments |
3.4 Relationship New Relationship(10)
3.4.1 New Relationship(10) Diagram
3.4.2 New Relationship(10) Properties
| Property | Value |
| Name | New Relationship(10) |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | SiteAreaMeasurement |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.5 Relationship New Relationship(10)
3.5.1 New Relationship(10) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| SiteAreaMeasurement | AreaMeasurementId |
3.5.2 New Relationship(10) Properties
| Property | Value |
| Name | New Relationship(10) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | SiteAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.6 Relationship New Relationship(11)
3.6.1 New Relationship(11) Diagram
3.6.2 New Relationship(11) Properties
| Property | Value |
| Name | New Relationship(11) |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | LandAreaMeasurement |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.7 Relationship New Relationship(11)
3.7.1 New Relationship(11) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| LandAreaMeasurement | AreaMeasurementId |
3.7.2 New Relationship(11) Properties
| Property | Value |
| Name | New Relationship(11) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | LandAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.8 Relationship New Relationship(12)
3.8.1 New Relationship(12) Diagram
3.8.2 New Relationship(12) Properties
| Property | Value |
| Name | New Relationship(12) |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | UnitAreaMeasurement |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.9 Relationship New Relationship(12)
3.9.1 New Relationship(12) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| UnitAreaMeasurement | AreaMeasurementId |
3.9.2 New Relationship(12) Properties
| Property | Value |
| Name | New Relationship(12) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | UnitAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.10 Relationship New Relationship(13)
3.10.1 New Relationship(13) Diagram
3.11 Relationship New Relationship(13)
3.11.1 New Relationship(13) Diagram
3.12 Relationship New Relationship(14)
3.12.1 New Relationship(14) Diagram
3.12.2 New Relationship(14) Properties
| Property | Value |
| Name | New Relationship(14) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | BuildingUnit |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.13 Relationship New Relationship(14)
3.13.1 New Relationship(14) Diagram
3.13.2 New Relationship(14) Properties
| Property | Value |
| Name | New Relationship(14) |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | BuildingUnit |
| Child field | UnitId |
| Child Cardinality | 0..1 |
| Comments |
3.14 Relationship New Relationship(15)
3.14.1 New Relationship(15) Diagram
3.15 Relationship New Relationship(15)
3.15.1 New Relationship(15) Diagram
3.16 Relationship New Relationship(16)
3.16.1 New Relationship(16) Diagram
3.17 Relationship New Relationship(16)
3.17.1 New Relationship(16) Diagram
3.18 Relationship New Relationship(18)
3.18.1 New Relationship(18) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| EmissionFactor | OperationalMeasurementGuid |
3.18.2 New Relationship(18) Properties
| Property | Value |
| Name | New Relationship(18) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactor |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 1..n |
| Comments |
3.19 Relationship New Relationship(19)
3.19.1 New Relationship(19) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| GhgEmissions | OperationalMeasurementGuid |
3.19.2 New Relationship(19) Properties
| Property | Value |
| Name | New Relationship(19) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissions |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 1..n |
| Comments |
3.20 Relationship New Relationship(2)
3.20.1 New Relationship(2) Diagram
3.20.2 New Relationship(2) Properties
| Property | Value |
| Name | New Relationship(2) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | Floor |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.21 Relationship New Relationship(21)
3.21.1 New Relationship(21) Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorSite | EmissionFactorGuid |
3.21.2 New Relationship(21) Properties
| Property | Value |
| Name | New Relationship(21) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
3.22 Relationship New Relationship(22)
3.22.1 New Relationship(22) Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorBuilding | EmissionFactorGuid |
3.22.2 New Relationship(22) Properties
| Property | Value |
| Name | New Relationship(22) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
3.23 Relationship New Relationship(23)
3.23.1 New Relationship(23) Diagram
| Parent Table | Parent field |
| GhgEmissions | GhgEmissionsGuid |
| Child Table | Child field |
| GhgEmissionsSite | GhgEmissionsGuid |
3.23.2 New Relationship(23) Properties
| Property | Value |
| Name | New Relationship(23) |
| Description | |
| Parent Document | GhgEmissions |
| Parent field | GhgEmissionsGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsSite |
| Child field | GhgEmissionsGuid |
| Child Cardinality | 0..1 |
| Comments |
3.24 Relationship New Relationship(24)
3.24.1 New Relationship(24) Diagram
| Parent Table | Parent field |
| GhgEmissions | GhgEmissionsGuid |
| Child Table | Child field |
| GhgEmissionsBuilding | GhgEmissionsGuid |
3.24.2 New Relationship(24) Properties
| Property | Value |
| Name | New Relationship(24) |
| Description | |
| Parent Document | GhgEmissions |
| Parent field | GhgEmissionsGuid |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsBuilding |
| Child field | GhgEmissionsGuid |
| Child Cardinality | 0..1 |
| Comments |
3.25 Relationship New Relationship(25)
3.25.1 New Relationship(25) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementSite | OperationalMeasurementGuid |
3.25.2 New Relationship(25) Properties
| Property | Value |
| Name | New Relationship(25) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.26 Relationship New Relationship(26)
3.26.1 New Relationship(26) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementLand | OperationalMeasurementGuid |
3.26.2 New Relationship(26) Properties
| Property | Value |
| Name | New Relationship(26) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.27 Relationship New Relationship(27)
3.27.1 New Relationship(27) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementBuilding | OperationalMeasurementGuid |
3.27.2 New Relationship(27) Properties
| Property | Value |
| Name | New Relationship(27) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.28 Relationship New Relationship(28)
3.28.1 New Relationship(28) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementFloor | OperationalMeasurementGuid |
3.28.2 New Relationship(28) Properties
| Property | Value |
| Name | New Relationship(28) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.29 Relationship New Relationship(28)
3.29.1 New Relationship(28) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementUnit | OperationalMeasurementGuid |
3.29.2 New Relationship(28) Properties
| Property | Value |
| Name | New Relationship(28) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.30 Relationship New Relationship(29)
3.30.1 New Relationship(29) Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| OperationalMeasurementSpace | OperationalMeasurementGuid |
3.30.2 New Relationship(29) Properties
| Property | Value |
| Name | New Relationship(29) |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..1 |
| Comments |
3.31 Relationship New Relationship(3)
3.31.1 New Relationship(3) Diagram
3.32 Relationship New Relationship(30)
3.32.1 New Relationship(30) Diagram
3.32.2 New Relationship(30) Properties
| Property | Value |
| Name | New Relationship(30) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.33 Relationship New Relationship(31)
3.33.1 New Relationship(31) Diagram
3.33.2 New Relationship(31) Properties
| Property | Value |
| Name | New Relationship(31) |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateGuid |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | ClimateGuid |
| Child Cardinality | 0..n |
| Comments |
3.34 Relationship New Relationship(32)
3.34.1 New Relationship(32) Diagram
3.34.2 New Relationship(32) Properties
| Property | Value |
| Name | New Relationship(32) |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateGuid |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | ClimateGuid |
| Child Cardinality | 0..n |
| Comments |
3.35 Relationship New Relationship(33)
3.35.1 New Relationship(33) Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorGuid |
| Child Table | Child field |
| EmissionFactorBusinessPartner | EmissionFactorGuid |
3.35.2 New Relationship(33) Properties
| Property | Value |
| Name | New Relationship(33) |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorGuid |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBusinessPartner |
| Child field | EmissionFactorGuid |
| Child Cardinality | 0..1 |
| Comments |
3.36 Relationship New Relationship(34)
3.36.1 New Relationship(34) Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterPortfolio | CostCenterId |
3.36.2 New Relationship(34) Properties
| Property | Value |
| Name | New Relationship(34) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.37 Relationship New Relationship(35)
3.37.1 New Relationship(35) Diagram
3.37.2 New Relationship(35) Properties
| Property | Value |
| Name | New Relationship(35) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.38 Relationship New Relationship(36)
3.38.1 New Relationship(36) Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterBuilding | CostCenterId |
3.38.2 New Relationship(36) Properties
| Property | Value |
| Name | New Relationship(36) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.39 Relationship New Relationship(37)
3.39.1 New Relationship(37) Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterRentalUnit | CostCenterId |
3.39.2 New Relationship(37) Properties
| Property | Value |
| Name | New Relationship(37) |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.40 Relationship New Relationship(4)
3.40.1 New Relationship(4) Diagram
3.40.2 New Relationship(4) Properties
| Property | Value |
| Name | New Relationship(4) |
| Description | |
| Parent Document | |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurement |
| Child field | ValidFrom |
| Child Cardinality | 1 |
| Comments |
3.41 Relationship New Relationship(41)
3.41.1 New Relationship(41) Diagram
3.41.2 New Relationship(41) Properties
| Property | Value |
| Name | New Relationship(41) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.42 Relationship New Relationship(42)
3.42.1 New Relationship(42) Diagram
3.42.2 New Relationship(42) Properties
| Property | Value |
| Name | New Relationship(42) |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.43 Relationship New Relationship(43)
3.43.1 New Relationship(43) Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalUnitId |
3.43.2 New Relationship(43) Properties
| Property | Value |
| Name | New Relationship(43) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.44 Relationship New Relationship(43)
3.44.1 New Relationship(43) Diagram
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalContractId |
3.44.2 New Relationship(43) Properties
| Property | Value |
| Name | New Relationship(43) |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
3.45 Relationship New Relationship(44)
3.45.1 New Relationship(44) Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitBuilding | RentalUnitId |
3.45.2 New Relationship(44) Properties
| Property | Value |
| Name | New Relationship(44) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.46 Relationship New Relationship(45)
3.46.1 New Relationship(45) Diagram
3.46.2 New Relationship(45) Properties
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.47 Relationship New Relationship(45)
3.47.1 New Relationship(45) Diagram
3.47.2 New Relationship(45) Properties
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.48 Relationship New Relationship(45)
3.48.1 New Relationship(45) Diagram
3.48.2 New Relationship(45) Properties
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.49 Relationship New Relationship(45)
3.49.1 New Relationship(45) Diagram
3.49.2 New Relationship(45) Properties
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.50 Relationship New Relationship(45)
3.50.1 New Relationship(45) Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | RentalUnitId |
3.50.2 New Relationship(45) Properties
| Property | Value |
| Name | New Relationship(45) |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.51 Relationship New Relationship(50)
3.51.1 New Relationship(50) Diagram
3.51.2 New Relationship(50) Properties
| Property | Value |
| Name | New Relationship(50) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.52 Relationship New Relationship(51)
3.52.1 New Relationship(51) Diagram
3.52.2 New Relationship(51) Properties
| Property | Value |
| Name | New Relationship(51) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.53 Relationship New Relationship(52)
3.53.1 New Relationship(52) Diagram
3.53.2 New Relationship(52) Properties
| Property | Value |
| Name | New Relationship(52) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.54 Relationship New Relationship(54)
3.54.1 New Relationship(54) Diagram
3.54.2 New Relationship(54) Properties
| Property | Value |
| Name | New Relationship(54) |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.55 Relationship New Relationship(6)
3.55.1 New Relationship(6) Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| BuildingAreaMeasurement | BuildingId |
3.55.2 New Relationship(6) Properties
| Property | Value |
| Name | New Relationship(6) |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | BuildingAreaMeasurement |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.56 Relationship New Relationship(6)
3.56.1 New Relationship(6) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| BuildingAreaMeasurement | AreaMeasurementId |
3.56.2 New Relationship(6) Properties
| Property | Value |
| Name | New Relationship(6) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | BuildingAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.57 Relationship New Relationship(7)
3.57.1 New Relationship(7) Diagram
3.58 Relationship New Relationship(7)
3.58.1 New Relationship(7) Diagram
3.59 Relationship New Relationship(8)
3.59.1 New Relationship(8) Diagram
3.59.2 New Relationship(8) Properties
| Property | Value |
| Name | New Relationship(8) |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | FloorAreaMeasurement |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.60 Relationship New Relationship(8)
3.60.1 New Relationship(8) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| FloorAreaMeasurement | AreaMeasurementId |
3.60.2 New Relationship(8) Properties
| Property | Value |
| Name | New Relationship(8) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | FloorAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.61 Relationship New Relationship(9)
3.61.1 New Relationship(9) Diagram
3.61.2 New Relationship(9) Properties
| Property | Value |
| Name | New Relationship(9) |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | SpaceAreaMeasurement |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.62 Relationship New Relationship(9)
3.62.1 New Relationship(9) Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| SpaceAreaMeasurement | AreaMeasurementId |
3.62.2 New Relationship(9) Properties
| Property | Value |
| Name | New Relationship(9) |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | SpaceAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.63 Relationship fk Account. to IndividualAccount.
3.63.1 fk Account. to IndividualAccount. Diagram
3.63.2 fk Account. to IndividualAccount. Properties
| Property | Value |
| Name | fk Account. to IndividualAccount. |
| Description | |
| Parent Document | Account |
| Parent field | AccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | AccountId |
| Child Cardinality | 0..n |
| Comments |
3.64 Relationship fk Address. to AddressContact.
3.64.1 fk Address. to AddressContact. Diagram
3.64.2 fk Address. to AddressContact. Properties
| Property | Value |
| Name | fk Address. to AddressContact. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.65 Relationship fk Address. to AddressOrganisation.
3.65.1 fk Address. to AddressOrganisation. Diagram
3.65.2 fk Address. to AddressOrganisation. Properties
| Property | Value |
| Name | fk Address. to AddressOrganisation. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | AddressId |
| Child Cardinality | 1..n |
| Comments |
3.66 Relationship fk AreaMeasurement. to RentalUnitSpace copy.
3.66.1 fk AreaMeasurement. to RentalUnitSpace copy. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | AreaMeasurementId |
3.66.2 fk AreaMeasurement. to RentalUnitSpace copy. Properties
| Property | Value |
| Name | fk AreaMeasurement. to RentalUnitSpace copy. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..n |
| Comments |
3.67 Relationship fk Building. to AddressBuilding.
3.67.1 fk Building. to AddressBuilding. Diagram
3.67.2 fk Building. to AddressBuilding. Properties
| Property | Value |
| Name | fk Building. to AddressBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | BuildingId |
| Child Cardinality | 1 |
| Comments |
3.68 Relationship fk Building. to CertificateBuilding.
3.68.1 fk Building. to CertificateBuilding. Diagram
3.68.2 fk Building. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Building. to CertificateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.69 Relationship fk Building. to ClimateBuilding.
3.69.1 fk Building. to ClimateBuilding. Diagram
3.69.2 fk Building. to ClimateBuilding. Properties
| Property | Value |
| Name | fk Building. to ClimateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.70 Relationship fk Building. to ComponentBuilding.
3.70.1 fk Building. to ComponentBuilding. Diagram
3.70.2 fk Building. to ComponentBuilding. Properties
| Property | Value |
| Name | fk Building. to ComponentBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.71 Relationship fk Building. to CostCenterBuilding.
3.71.1 fk Building. to CostCenterBuilding. Diagram
3.71.2 fk Building. to CostCenterBuilding. Properties
| Property | Value |
| Name | fk Building. to CostCenterBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.72 Relationship fk Building. to EmissionFactorSite.
3.72.1 fk Building. to EmissionFactorSite. Diagram
3.72.2 fk Building. to EmissionFactorSite. Properties
| Property | Value |
| Name | fk Building. to EmissionFactorSite. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.73 Relationship fk Building. to OperationalMeasurementBuilding.
3.73.1 fk Building. to OperationalMeasurementBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| OperationalMeasurementBuilding | BuildingId |
3.73.2 fk Building. to OperationalMeasurementBuilding. Properties
| Property | Value |
| Name | fk Building. to OperationalMeasurementBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.74 Relationship fk Building. to OrganisationBuilding.
3.74.1 fk Building. to OrganisationBuilding. Diagram
3.74.2 fk Building. to OrganisationBuilding. Properties
| Property | Value |
| Name | fk Building. to OrganisationBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.75 Relationship fk Building. to PortfolioBuilding.
3.75.1 fk Building. to PortfolioBuilding. Diagram
3.75.2 fk Building. to PortfolioBuilding. Properties
| Property | Value |
| Name | fk Building. to PortfolioBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.76 Relationship fk Building. to RentalUnitBuilding.
3.76.1 fk Building. to RentalUnitBuilding. Diagram
3.76.2 fk Building. to RentalUnitBuilding. Properties
| Property | Value |
| Name | fk Building. to RentalUnitBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.77 Relationship fk Building. to SustainabilityIndicators.
3.77.1 fk Building. to SustainabilityIndicators. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| SustainabilityIndicators | BuildingId |
3.77.2 fk Building. to SustainabilityIndicators. Properties
| Property | Value |
| Name | fk Building. to SustainabilityIndicators. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | SustainabilityIndicators |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.78 Relationship fk Building. to TransactionBuilding.
3.78.1 fk Building. to TransactionBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| IndividualAccountBuilding | BuildingId |
3.78.2 fk Building. to TransactionBuilding. Properties
| Property | Value |
| Name | fk Building. to TransactionBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.79 Relationship fk Building. to ValuationBuilding.
3.79.1 fk Building. to ValuationBuilding. Diagram
3.79.2 fk Building. to ValuationBuilding. Properties
| Property | Value |
| Name | fk Building. to ValuationBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.80 Relationship fk Building. to gHgEmissionsBuilding.
3.80.1 fk Building. to gHgEmissionsBuilding. Diagram
3.80.2 fk Building. to gHgEmissionsBuilding. Properties
| Property | Value |
| Name | fk Building. to gHgEmissionsBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.81 Relationship fk Certificate. to CertificateBuilding.
3.81.1 fk Certificate. to CertificateBuilding. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateBuilding | CertificateId |
3.81.2 fk Certificate. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.82 Relationship fk Certificate. to CertificateBuilding.
3.82.1 fk Certificate. to CertificateBuilding. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateComponent | CertificateId |
3.82.2 fk Certificate. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.83 Relationship fk Certificate. to CertificateBuilding.
3.83.1 fk Certificate. to CertificateBuilding. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateValuation | CertificateId |
3.83.2 fk Certificate. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.84 Relationship fk Certificate. to CertificateBuilding.
3.84.1 fk Certificate. to CertificateBuilding. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateSystem | CertificateId |
3.84.2 fk Certificate. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.85 Relationship fk Component. to Certificate.
3.85.1 fk Component. to Certificate. Diagram
3.85.2 fk Component. to Certificate. Properties
| Property | Value |
| Name | fk Component. to Certificate. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | Certificate |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.86 Relationship fk Component. to Certificate.
3.86.1 fk Component. to Certificate. Diagram
| Parent Table | Parent field |
| Component | ComponentId |
| Child Table | Child field |
| CertificateComponent | ComponentId |
3.86.2 fk Component. to Certificate. Properties
| Property | Value |
| Name | fk Component. to Certificate. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.87 Relationship fk Component. to New Document.
3.87.1 fk Component. to New Document. Diagram
3.87.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.88 Relationship fk Component. to New Document.
3.88.1 fk Component. to New Document. Diagram
3.88.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.89 Relationship fk Component. to New Document.
3.89.1 fk Component. to New Document. Diagram
3.89.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.90 Relationship fk Component. to New Document.
3.90.1 fk Component. to New Document. Diagram
3.90.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.91 Relationship fk Component. to New Document.
3.91.1 fk Component. to New Document. Diagram
3.91.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.92 Relationship fk Component. to New Document.
3.92.1 fk Component. to New Document. Diagram
3.92.2 fk Component. to New Document. Properties
| Property | Value |
| Name | fk Component. to New Document. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | ComponentId |
| Child Cardinality | 1..n |
| Comments |
3.93 Relationship fk Contact. to AddressContact.
3.93.1 fk Contact. to AddressContact. Diagram
3.93.2 fk Contact. to AddressContact. Properties
| Property | Value |
| Name | fk Contact. to AddressContact. |
| Description | |
| Parent Document | Contact |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
3.94 Relationship fk Contact. to RoleContact.
3.94.1 fk Contact. to RoleContact. Diagram
3.94.2 fk Contact. to RoleContact. Properties
| Property | Value |
| Name | fk Contact. to RoleContact. |
| Description | |
| Parent Document | Contact |
| Parent field | ContactId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
3.95 Relationship fk CostCenter. to Transaction.
3.95.1 fk CostCenter. to Transaction. Diagram
3.95.2 fk CostCenter. to Transaction. Properties
| Property | Value |
| Name | fk CostCenter. to Transaction. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | Transaction |
| Child field | CostCenterId |
| Child Cardinality | 1..n |
| Comments |
3.96 Relationship fk Floor. to ComponentFloor.
3.96.1 fk Floor. to ComponentFloor. Diagram
3.96.2 fk Floor. to ComponentFloor. Properties
| Property | Value |
| Name | fk Floor. to ComponentFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.97 Relationship fk Floor. to OperationalMeasurementFloor.
3.97.1 fk Floor. to OperationalMeasurementFloor. Diagram
3.97.2 fk Floor. to OperationalMeasurementFloor. Properties
| Property | Value |
| Name | fk Floor. to OperationalMeasurementFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.98 Relationship fk Floor. to RentalUnitFloor.
3.98.1 fk Floor. to RentalUnitFloor. Diagram
3.98.2 fk Floor. to RentalUnitFloor. Properties
| Property | Value |
| Name | fk Floor. to RentalUnitFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.99 Relationship fk IndividualAccount. to CostCenter.
3.99.1 fk IndividualAccount. to CostCenter. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| CostCenter | IndividualAccountId |
3.99.2 fk IndividualAccount. to CostCenter. Properties
| Property | Value |
| Name | fk IndividualAccount. to CostCenter. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | CostCenter |
| Child field | IndividualAccountId |
| Child Cardinality | 1..n |
| Comments |
3.100 Relationship fk IndividualAccount. to IndividualAccountPortfolio.
3.100.1 fk IndividualAccount. to IndividualAccountPortfolio. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountPortfolio | IndividualAccountId |
3.100.2 fk IndividualAccount. to IndividualAccountPortfolio. Properties
| Property | Value |
| Name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.101 Relationship fk IndividualAccount. to Portfolio.
3.101.1 fk IndividualAccount. to Portfolio. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| Portfolio | IndividualAccountId |
3.101.2 fk IndividualAccount. to Portfolio. Properties
| Property | Value |
| Name | fk IndividualAccount. to Portfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | Portfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.102 Relationship fk IndividualAccount. to TransactionBuilding.
3.102.1 fk IndividualAccount. to TransactionBuilding. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountBuilding | IndividualAccountId |
3.102.2 fk IndividualAccount. to TransactionBuilding. Properties
| Property | Value |
| Name | fk IndividualAccount. to TransactionBuilding. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.103 Relationship fk IndividualAccount. to TransactionSite.
3.103.1 fk IndividualAccount. to TransactionSite. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountSite | IndividualAccountId |
3.103.2 fk IndividualAccount. to TransactionSite. Properties
| Property | Value |
| Name | fk IndividualAccount. to TransactionSite. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.104 Relationship fk IndividualAccount. to ValuationAccount.
3.104.1 fk IndividualAccount. to ValuationAccount. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| ValuationAccount | IndividualAccountId |
3.104.2 fk IndividualAccount. to ValuationAccount. Properties
| Property | Value |
| Name | fk IndividualAccount. to ValuationAccount. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | ValuationAccount |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.105 Relationship fk Land. to AddressLand.
3.105.1 fk Land. to AddressLand. Diagram
3.105.2 fk Land. to AddressLand. Properties
| Property | Value |
| Name | fk Land. to AddressLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | LandId |
| Child Cardinality | 1 |
| Comments |
3.106 Relationship fk Land. to OperationalMeasurementLand.
3.106.1 fk Land. to OperationalMeasurementLand. Diagram
3.106.2 fk Land. to OperationalMeasurementLand. Properties
| Property | Value |
| Name | fk Land. to OperationalMeasurementLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.107 Relationship fk Land. to OrganisationLand.
3.107.1 fk Land. to OrganisationLand. Diagram
3.108 Relationship fk Land. to PortfolioLand.
3.108.1 fk Land. to PortfolioLand. Diagram
3.108.2 fk Land. to PortfolioLand. Properties
| Property | Value |
| Name | fk Land. to PortfolioLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.109 Relationship fk Land. to RentalUnitLand.
3.109.1 fk Land. to RentalUnitLand. Diagram
3.109.2 fk Land. to RentalUnitLand. Properties
| Property | Value |
| Name | fk Land. to RentalUnitLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.110 Relationship fk Land. to ValuationLand.
3.110.1 fk Land. to ValuationLand. Diagram
3.110.2 fk Land. to ValuationLand. Properties
| Property | Value |
| Name | fk Land. to ValuationLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.111 Relationship fk OperationalMeasurement. to ValuationOperationalMeasurement.
3.111.1 fk OperationalMeasurement. to ValuationOperationalMeasurement. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementGuid |
| Child Table | Child field |
| ValuationOperationalMeasurement | OperationalMeasurementGuid |
3.111.2 fk OperationalMeasurement. to ValuationOperationalMeasurement. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementGuid |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | OperationalMeasurementGuid |
| Child Cardinality | 0..n |
| Comments |
3.112 Relationship fk Organisation. to AccountOrganisation.
3.112.1 fk Organisation. to AccountOrganisation. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| IndividualAccount | OrganisationId |
3.112.2 fk Organisation. to AccountOrganisation. Properties
| Property | Value |
| Name | fk Organisation. to AccountOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.113 Relationship fk Organisation. to AddressOrganisation.
3.113.1 fk Organisation. to AddressOrganisation. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| AddressOrganisation | OrganisationId |
3.113.2 fk Organisation. to AddressOrganisation. Properties
| Property | Value |
| Name | fk Organisation. to AddressOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 1..n |
| Comments |
3.114 Relationship fk Organisation. to Contact.
3.114.1 fk Organisation. to Contact. Diagram
3.114.2 fk Organisation. to Contact. Properties
| Property | Value |
| Name | fk Organisation. to Contact. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | Contact |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.115 Relationship fk Organisation. to CostCenter.
3.115.1 fk Organisation. to CostCenter. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| CostCenter | OrganisationId |
3.115.2 fk Organisation. to CostCenter. Properties
| Property | Value |
| Name | fk Organisation. to CostCenter. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | CostCenter |
| Child field | OrganisationId |
| Child Cardinality | 1 |
| Comments |
3.116 Relationship fk Organisation. to RoleOrganisation.
3.116.1 fk Organisation. to RoleOrganisation. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| RoleOrganisation | OrganisationId |
3.116.2 fk Organisation. to RoleOrganisation. Properties
| Property | Value |
| Name | fk Organisation. to RoleOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.117 Relationship fk Portfolio. to CostCenterPortfolio.
3.117.1 fk Portfolio. to CostCenterPortfolio. Diagram
3.117.2 fk Portfolio. to CostCenterPortfolio. Properties
| Property | Value |
| Name | fk Portfolio. to CostCenterPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.118 Relationship fk Portfolio. to OrganisationPortfolio.
3.118.1 fk Portfolio. to OrganisationPortfolio. Diagram
3.118.2 fk Portfolio. to OrganisationPortfolio. Properties
| Property | Value |
| Name | fk Portfolio. to OrganisationPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.119 Relationship fk Portfolio. to PortfolioStrategy.
3.119.1 fk Portfolio. to PortfolioStrategy. Diagram
3.119.2 fk Portfolio. to PortfolioStrategy. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | PortfolioStrategy |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.120 Relationship fk Portfolio. to PortfolioUnit.
3.120.1 fk Portfolio. to PortfolioUnit. Diagram
3.120.2 fk Portfolio. to PortfolioUnit. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioUnit. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.121 Relationship fk Portfolio. to RolePortfolioStrategy.
3.121.1 fk Portfolio. to RolePortfolioStrategy. Diagram
| Parent Table | Parent field |
| Portfolio | PortfolioId |
| Child Table | Child field |
| RolePortfolioStrategy | PortfolioStrategyId |
3.121.2 fk Portfolio. to RolePortfolioStrategy. Properties
| Property | Value |
| Name | fk Portfolio. to RolePortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | PortfolioStrategyId |
| Child Cardinality | 0..n |
| Comments |
3.122 Relationship fk Portfolio. to TransactionPortfolio.
3.122.1 fk Portfolio. to TransactionPortfolio. Diagram
| Parent Table | Parent field |
| Portfolio | [-1] |
| Child Table | Child field |
| IndividualAccountPortfolio | PortfolioId |
3.122.2 fk Portfolio. to TransactionPortfolio. Properties
| Property | Value |
| Name | fk Portfolio. to TransactionPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.123 Relationship fk RentalContract. to LeaseOption.
3.123.1 fk RentalContract. to LeaseOption. Diagram
3.123.2 fk RentalContract. to LeaseOption. Properties
| Property | Value |
| Name | fk RentalContract. to LeaseOption. |
| Description | |
| Parent Document | RentalContract |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RentalOption |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
3.124 Relationship fk RentalContract. to RentalContractOrganisation.
3.124.1 fk RentalContract. to RentalContractOrganisation. Diagram
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRole | RentalContractId |
3.124.2 fk RentalContract. to RentalContractOrganisation. Properties
| Property | Value |
| Name | fk RentalContract. to RentalContractOrganisation. |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
3.125 Relationship fk RentalContract. to RentalPaymentId.
3.125.1 fk RentalContract. to RentalPaymentId. Diagram
3.125.2 fk RentalContract. to RentalPaymentId. Properties
| Property | Value |
| Name | fk RentalContract. to RentalPaymentId. |
| Description | |
| Parent Document | RentalContract |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RentalPayment |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
3.126 Relationship fk RentalPayment. to Dunning.
3.126.1 fk RentalPayment. to Dunning. Diagram
| Parent Table | Parent field |
| RentalPayment | RentalPaymentId |
| Child Table | Child field |
| Dunning | RentalPaymentId |
3.126.2 fk RentalPayment. to Dunning. Properties
| Property | Value |
| Name | fk RentalPayment. to Dunning. |
| Description | |
| Parent Document | RentalPayment |
| Parent field | RentalPaymentId |
| Parent Cardinality | 1 |
| Child Document | Dunning |
| Child field | RentalPaymentId |
| Child Cardinality | 0..n |
| Comments |
3.127 Relationship fk RentalUnit. to AddressRentalUnit.
3.127.1 fk RentalUnit. to AddressRentalUnit. Diagram
3.127.2 fk RentalUnit. to AddressRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to AddressRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 1 |
| Comments |
3.128 Relationship fk RentalUnit. to CostCenterRentalUnit.
3.128.1 fk RentalUnit. to CostCenterRentalUnit. Diagram
3.128.2 fk RentalUnit. to CostCenterRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to CostCenterRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.129 Relationship fk RentalUnit. to OrganisationRentalUnit.
3.129.1 fk RentalUnit. to OrganisationRentalUnit. Diagram
3.129.2 fk RentalUnit. to OrganisationRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to OrganisationRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.130 Relationship fk RentalUnit. to TenantCommunication.
3.130.1 fk RentalUnit. to TenantCommunication. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| TenantCommunication | RentalUnitId |
3.130.2 fk RentalUnit. to TenantCommunication. Properties
| Property | Value |
| Name | fk RentalUnit. to TenantCommunication. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunication |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.131 Relationship fk Role. to OperationalMeasurement.
3.131.1 fk Role. to OperationalMeasurement. Diagram
3.131.2 fk Role. to OperationalMeasurement. Properties
| Property | Value |
| Name | fk Role. to OperationalMeasurement. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurement |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
3.132 Relationship fk Role. to OperationalMeasurement.
3.132.1 fk Role. to OperationalMeasurement. Diagram
3.132.2 fk Role. to OperationalMeasurement. Properties
| Property | Value |
| Name | fk Role. to OperationalMeasurement. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBusinessPartner |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
3.133 Relationship fk Role. to OrganisationBuilding.
3.133.1 fk Role. to OrganisationBuilding. Diagram
3.133.2 fk Role. to OrganisationBuilding. Properties
| Property | Value |
| Name | fk Role. to OrganisationBuilding. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.134 Relationship fk Role. to OrganisationLand.
3.134.1 fk Role. to OrganisationLand. Diagram
3.135 Relationship fk Role. to OrganisationPortfolioStrategy.
3.135.1 fk Role. to OrganisationPortfolioStrategy. Diagram
3.135.2 fk Role. to OrganisationPortfolioStrategy. Properties
| Property | Value |
| Name | fk Role. to OrganisationPortfolioStrategy. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.136 Relationship fk Role. to OrganisationRentalUnit.
3.136.1 fk Role. to OrganisationRentalUnit. Diagram
3.136.2 fk Role. to OrganisationRentalUnit. Properties
| Property | Value |
| Name | fk Role. to OrganisationRentalUnit. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.137 Relationship fk Role. to OrganisationRentalUnit.
3.137.1 fk Role. to OrganisationRentalUnit. Diagram
3.137.2 fk Role. to OrganisationRentalUnit. Properties
| Property | Value |
| Name | fk Role. to OrganisationRentalUnit. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.138 Relationship fk Role. to OrganisationSite.
3.138.1 fk Role. to OrganisationSite. Diagram
3.139 Relationship fk Role. to OrganisationValuation.
3.139.1 fk Role. to OrganisationValuation. Diagram
3.139.2 fk Role. to OrganisationValuation. Properties
| Property | Value |
| Name | fk Role. to OrganisationValuation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.140 Relationship fk Role. to RentalContractOrganisation.
3.140.1 fk Role. to RentalContractOrganisation. Diagram
3.140.2 fk Role. to RentalContractOrganisation. Properties
| Property | Value |
| Name | fk Role. to RentalContractOrganisation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.141 Relationship fk Role. to RoleContact.
3.141.1 fk Role. to RoleContact. Diagram
3.141.2 fk Role. to RoleContact. Properties
| Property | Value |
| Name | fk Role. to RoleContact. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.142 Relationship fk Role. to RoleContact.
3.142.1 fk Role. to RoleContact. Diagram
3.142.2 fk Role. to RoleContact. Properties
| Property | Value |
| Name | fk Role. to RoleContact. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.143 Relationship fk Role. to TenantCommunicationRole.
3.143.1 fk Role. to TenantCommunicationRole. Diagram
3.143.2 fk Role. to TenantCommunicationRole. Properties
| Property | Value |
| Name | fk Role. to TenantCommunicationRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.144 Relationship fk Site. to AddressSite.
3.144.1 fk Site. to AddressSite. Diagram
3.144.2 fk Site. to AddressSite. Properties
| Property | Value |
| Name | fk Site. to AddressSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | SiteId |
| Child Cardinality | 1 |
| Comments |
3.145 Relationship fk Site. to ClimateSite.
3.145.1 fk Site. to ClimateSite. Diagram
3.145.2 fk Site. to ClimateSite. Properties
| Property | Value |
| Name | fk Site. to ClimateSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.146 Relationship fk Site. to ComponentFloor(2).
3.146.1 fk Site. to ComponentFloor(2). Diagram
3.146.2 fk Site. to ComponentFloor(2). Properties
| Property | Value |
| Name | fk Site. to ComponentFloor(2). |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.147 Relationship fk Site. to CostCenterSite.
3.147.1 fk Site. to CostCenterSite. Diagram
3.147.2 fk Site. to CostCenterSite. Properties
| Property | Value |
| Name | fk Site. to CostCenterSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.148 Relationship fk Site. to EmissionFactorBuilding.
3.148.1 fk Site. to EmissionFactorBuilding. Diagram
3.148.2 fk Site. to EmissionFactorBuilding. Properties
| Property | Value |
| Name | fk Site. to EmissionFactorBuilding. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.149 Relationship fk Site. to OperationalMeasurementSite.
3.149.1 fk Site. to OperationalMeasurementSite. Diagram
3.149.2 fk Site. to OperationalMeasurementSite. Properties
| Property | Value |
| Name | fk Site. to OperationalMeasurementSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.150 Relationship fk Site. to OrganisationSite.
3.150.1 fk Site. to OrganisationSite. Diagram
3.151 Relationship fk Site. to PortfolioSite.
3.151.1 fk Site. to PortfolioSite. Diagram
3.151.2 fk Site. to PortfolioSite. Properties
| Property | Value |
| Name | fk Site. to PortfolioSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.152 Relationship fk Site. to TransactionSite.
3.152.1 fk Site. to TransactionSite. Diagram
3.152.2 fk Site. to TransactionSite. Properties
| Property | Value |
| Name | fk Site. to TransactionSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.153 Relationship fk Site. to gHgEmissionsSite.
3.153.1 fk Site. to gHgEmissionsSite. Diagram
3.153.2 fk Site. to gHgEmissionsSite. Properties
| Property | Value |
| Name | fk Site. to gHgEmissionsSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionsSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.154 Relationship fk Space. to New Document.
3.154.1 fk Space. to New Document. Diagram
3.154.2 fk Space. to New Document. Properties
| Property | Value |
| Name | fk Space. to New Document. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.155 Relationship fk Space. to OperationalMeasurementSpace.
3.155.1 fk Space. to OperationalMeasurementSpace. Diagram
3.155.2 fk Space. to OperationalMeasurementSpace. Properties
| Property | Value |
| Name | fk Space. to OperationalMeasurementSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.156 Relationship fk Space. to RentalUnitSpace.
3.156.1 fk Space. to RentalUnitSpace. Diagram
3.156.2 fk Space. to RentalUnitSpace. Properties
| Property | Value |
| Name | fk Space. to RentalUnitSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.157 Relationship fk System. to CertificateSystem.
3.157.1 fk System. to CertificateSystem. Diagram
3.157.2 fk System. to CertificateSystem. Properties
| Property | Value |
| Name | fk System. to CertificateSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | SystemId |
| Child Cardinality | 0..n |
| Comments |
3.158 Relationship fk System. to ComponentSystem.
3.158.1 fk System. to ComponentSystem. Diagram
3.158.2 fk System. to ComponentSystem. Properties
| Property | Value |
| Name | fk System. to ComponentSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | SystemId |
| Child Cardinality | 1..n |
| Comments |
3.159 Relationship fk TenantCommunication. to TenantCommunication.
3.159.1 fk TenantCommunication. to TenantCommunication. Diagram
| Parent Table | Parent field |
| TenantCommunication | TenantCommunicationId |
| Child Table | Child field |
| TenantCommunicationRole | TenantCommunicationId |
3.159.2 fk TenantCommunication. to TenantCommunication. Properties
| Property | Value |
| Name | fk TenantCommunication. to TenantCommunication. |
| Description | |
| Parent Document | TenantCommunication |
| Parent field | TenantCommunicationId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | TenantCommunicationId |
| Child Cardinality | 0..n |
| Comments |
3.160 Relationship fk Type. to Component.
3.160.1 fk Type. to Component. Diagram
3.161 Relationship fk Unit. to ComponentUnit.
3.161.1 fk Unit. to ComponentUnit. Diagram
3.161.2 fk Unit. to ComponentUnit. Properties
| Property | Value |
| Name | fk Unit. to ComponentUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.162 Relationship fk Unit. to OperationalMeasurementUnit.
3.162.1 fk Unit. to OperationalMeasurementUnit. Diagram
3.162.2 fk Unit. to OperationalMeasurementUnit. Properties
| Property | Value |
| Name | fk Unit. to OperationalMeasurementUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.163 Relationship fk Unit. to PortfolioUnit.
3.163.1 fk Unit. to PortfolioUnit. Diagram
3.163.2 fk Unit. to PortfolioUnit. Properties
| Property | Value |
| Name | fk Unit. to PortfolioUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.164 Relationship fk Unit. to RentalUnitUnit.
3.164.1 fk Unit. to RentalUnitUnit. Diagram
3.164.2 fk Unit. to RentalUnitUnit. Properties
| Property | Value |
| Name | fk Unit. to RentalUnitUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.165 Relationship fk Valuation. to CertificateValuation.
3.165.1 fk Valuation. to CertificateValuation. Diagram
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| CertificateValuation | ValuationId |
3.165.2 fk Valuation. to CertificateValuation. Properties
| Property | Value |
| Name | fk Valuation. to CertificateValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.166 Relationship fk Valuation. to OrganisationValuation.
3.166.1 fk Valuation. to OrganisationValuation. Diagram
3.166.2 fk Valuation. to OrganisationValuation. Properties
| Property | Value |
| Name | fk Valuation. to OrganisationValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.167 Relationship fk Valuation. to ValuationAreaMeasurement.
3.167.1 fk Valuation. to ValuationAreaMeasurement. Diagram
3.167.2 fk Valuation. to ValuationAreaMeasurement. Properties
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationAccount |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.168 Relationship fk Valuation. to ValuationAreaMeasurement.
3.168.1 fk Valuation. to ValuationAreaMeasurement. Diagram
3.168.2 fk Valuation. to ValuationAreaMeasurement. Properties
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.169 Relationship fk Valuation. to ValuationAreaMeasurement.
3.169.1 fk Valuation. to ValuationAreaMeasurement. Diagram
3.169.2 fk Valuation. to ValuationAreaMeasurement. Properties
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.170 Relationship fk Valuation. to ValuationAreaMeasurement.
3.170.1 fk Valuation. to ValuationAreaMeasurement. Diagram
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| ValuationOperationalMeasurement | ValuationId |
3.170.2 fk Valuation. to ValuationAreaMeasurement. Properties
| Property | Value |
| Name | fk Valuation. to ValuationAreaMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |